Skip to main content

PlotToken

Struct PlotToken 

Source
pub struct PlotToken<'ui> { /* private fields */ }
Expand description

Token that represents an active plot

The plot will be automatically ended when this token is dropped.

Implementations§

Source§

impl<'ui> PlotToken<'ui>

Source

pub fn end(self)

Manually end the plot

This is called automatically when the token is dropped, but you can call it manually if needed.

Source

pub fn plot_draw_list(&self) -> Option<DrawListMut<'_>>

Get the active plot draw list as a frame-bound wrapper.

Source

pub fn push_plot_clip_rect(&self, expand: f32) -> PlotClipRectToken<'_>

Push a plot clip rect on this active plot.

The returned token pops the clip rect when dropped and cannot outlive the active plot token it was created from.

Trait Implementations§

Source§

impl<'ui> Drop for PlotToken<'ui>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'ui> !RefUnwindSafe for PlotToken<'ui>

§

impl<'ui> !Send for PlotToken<'ui>

§

impl<'ui> !Sync for PlotToken<'ui>

§

impl<'ui> !UnwindSafe for PlotToken<'ui>

§

impl<'ui> Freeze for PlotToken<'ui>

§

impl<'ui> Unpin for PlotToken<'ui>

§

impl<'ui> UnsafeUnpin for PlotToken<'ui>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more