Skip to main content

SegmentHandle

Struct SegmentHandle 

Source
pub struct SegmentHandle<'a> { /* private fields */ }
Expand description

A borrowed segment, obtained from Map::segment, that an animation can be attached to.

Mirrors NodeHandle, with the same modifier-then-terminal shape:

A segment can carry one of each at once; the state is drawn underneath the event, same as node effects.

Implementations§

Source§

impl SegmentHandle<'_>

Source

pub fn color(self, color: Color32) -> Self

Overrides the colour of the effect about to be attached.

Without this the effect uses the current style’s alert_color.

Source

pub fn flash(self, at: Instant)

Brief flash that fades back out. The segment analogue of NodeHandle::pulse — reads as “something happened on this route”.

Source

pub fn comet_once(self, at: Instant, direction: CometDirection)

Single dot pass from one endpoint to the other, then gone. The event-driven counterpart to Self::comet — reads as “one thing moved along this route just now” rather than “traffic keeps flowing this way”. direction picks which endpoint it starts from.

Source

pub fn wipe(self, at: Instant)

Line drawing itself in from the first endpoint to the second, then gone — reads as “this route was just established” rather than “something travelled along it”.

Source

pub fn comet(self)

Lasting dot travelling along the segment. Runs until Self::clear.

Source

pub fn dash(self)

Lasting dashed line, its pattern sliding along the segment (“marching ants”). Runs until Self::clear.

Source

pub fn glow_band(self)

Lasting band of brightness travelling the length of the segment and looping. Reads as “flow”, calmer than Self::dash. Runs until Self::clear.

Source

pub fn chevrons(self)

Lasting row of arrow shapes sliding along the segment, pointing the way. Runs until Self::clear.

Source

pub fn clear(self)

Removes both the notification and the lasting state of this segment.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for SegmentHandle<'a>

§

impl<'a> !Send for SegmentHandle<'a>

§

impl<'a> !Sync for SegmentHandle<'a>

§

impl<'a> !UnwindSafe for SegmentHandle<'a>

§

impl<'a> Freeze for SegmentHandle<'a>

§

impl<'a> Unpin for SegmentHandle<'a>

§

impl<'a> UnsafeUnpin for SegmentHandle<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

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

Source§

type Error = !

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