Struct ProfileDuration
pub struct ProfileDuration { /* private fields */ }Expand description
Result from profiling between two measurements. This can either be a duration or a future that resolves to a duration.
The future resolves to None when the window turned out to carry no
measurement, which a backend can only discover once the device has answered.
That absence is not a zero: zero is the fastest duration there is, so a
caller comparing candidates would let an unmeasured one win every comparison
it enters.
Implementations§
§impl ProfileDuration
impl ProfileDuration
pub fn timing_method(&self) -> TimingMethod
pub fn timing_method(&self) -> TimingMethod
The method used to measure the execution time.
pub fn new(
future: Pin<Box<dyn Future<Output = Option<ProfileTicks>> + Send>>,
method: TimingMethod,
) -> ProfileDuration
pub fn new( future: Pin<Box<dyn Future<Output = Option<ProfileTicks>> + Send>>, method: TimingMethod, ) -> ProfileDuration
Create a new ProfileDuration from a future that resolves to a duration.
pub fn new_system_time(start: Instant, end: Instant) -> ProfileDuration
pub fn new_system_time(start: Instant, end: Instant) -> ProfileDuration
Create a new ProfileDuration straight from a duration.
pub fn new_device_time(
future: impl Future<Output = ProfileTicks> + Send + 'static,
) -> ProfileDuration
pub fn new_device_time( future: impl Future<Output = ProfileTicks> + Send + 'static, ) -> ProfileDuration
Create a new ProfileDuration from a future that resolves to a duration.
pub fn new_device_time_maybe(
future: impl Future<Output = Option<ProfileTicks>> + Send + 'static,
) -> ProfileDuration
pub fn new_device_time_maybe( future: impl Future<Output = Option<ProfileTicks>> + Send + 'static, ) -> ProfileDuration
Create a new ProfileDuration from a future that may resolve to no
measurement at all, for a backend that only learns the window carried
none once the device has answered.
pub fn into_future(
self,
) -> Pin<Box<dyn Future<Output = Option<ProfileTicks>> + Send>>
pub fn into_future( self, ) -> Pin<Box<dyn Future<Output = Option<ProfileTicks>> + Send>>
Retrieve the future that resolves the profile.
pub async fn resolve(self) -> Option<ProfileTicks>
pub async fn resolve(self) -> Option<ProfileTicks>
Resolve the actual duration of the profile, possibly by waiting for the future to complete.
None when the window carried no measurement. See the type’s docs for
why that is not reported as a zero duration.
Auto Trait Implementations§
impl !RefUnwindSafe for ProfileDuration
impl !Sync for ProfileDuration
impl !UnwindSafe for ProfileDuration
impl Freeze for ProfileDuration
impl Send for ProfileDuration
impl Unpin for ProfileDuration
impl UnsafeUnpin for ProfileDuration
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
§impl<K, Q> Comparable<Q> for K
impl<K, Q> Comparable<Q> for K
§impl<K, Q> Equivalent<Q> for K
impl<K, Q> Equivalent<Q> for K
§fn equivalent(&self, key: &Q) -> bool
fn equivalent(&self, key: &Q) -> bool
key and return true if they are equal.impl<T> ErasedDestructor for Twhere
T: 'static,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more