Skip to main content

NodeState

Struct NodeState 

Source
pub struct NodeState { /* private fields */ }
Expand description

Runtime state tracked for every ModifierNode.

This type is part of the internal node system API and should not be directly constructed or manipulated by external code. Modifier nodes automatically receive and manage their NodeState through the modifier chain infrastructure.

Implementations§

Source§

impl NodeState

Source

pub const fn new() -> NodeState

Creates the state of a node that is not attached to a chain yet and has no capabilities.

Source

pub const fn sentinel() -> NodeState

Creates the state of a head or tail marker of a chain. A marker counts as attached and has no capabilities.

Source

pub fn set_capabilities(&self, capabilities: NodeCapabilities)

Records the capabilities of the node that owns this state. The chain calls it when it adds or updates the node.

Source

pub fn capabilities(&self) -> NodeCapabilities

The capabilities of the node that owns this state.

Source

pub fn set_aggregate_child_capabilities(&self, capabilities: NodeCapabilities)

Records the union of the capabilities of the node that owns this state and of every node after it in the chain.

Source

pub fn aggregate_child_capabilities(&self) -> NodeCapabilities

The union of the capabilities of the node that owns this state and of every node after it in the chain. Compose’s aggregateChildKindSet.

Source

pub fn set_attached(&self, attached: bool)

Marks the node as attached to a chain or as detached from it.

Source

pub fn is_attached(&self) -> bool

Whether the node is attached to a chain. It is true after on_attach ran and before on_detach runs.

Source

pub fn is_sentinel(&self) -> bool

Whether this state belongs to the head or tail marker of a chain. A marker is no real modifier node.

Trait Implementations§

Source§

impl Debug for NodeState

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Default for NodeState

Source§

fn default() -> NodeState

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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, !>

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.