TextWriter

Struct TextWriter 

Source
pub struct TextWriter<'w, 's, R>
where R: TextRoot,
{ /* private fields */ }
Expand description

System parameter for reading and writing text spans in a text block.

R is the root text component, and S is the text span component on children.

Implementations§

Source§

impl<'w, 's, R> TextWriter<'w, 's, R>
where R: TextRoot,

Source

pub fn get( &mut self, root_entity: Entity, index: usize, ) -> Option<(Entity, usize, Mut<'_, String>, Mut<'_, TextFont>, Mut<'_, TextColor>)>

Gets a mutable reference to a text span within a text block at a specific index in the flattened span list.

Source

pub fn get_text( &mut self, root_entity: Entity, index: usize, ) -> Option<Mut<'_, String>>

Gets the text value of a text span within a text block at a specific index in the flattened span list.

Source

pub fn get_font( &mut self, root_entity: Entity, index: usize, ) -> Option<Mut<'_, TextFont>>

Gets the TextFont of a text span within a text block at a specific index in the flattened span list.

Source

pub fn get_color( &mut self, root_entity: Entity, index: usize, ) -> Option<Mut<'_, TextColor>>

Gets the TextColor of a text span within a text block at a specific index in the flattened span list.

Source

pub fn text(&mut self, root_entity: Entity, index: usize) -> Mut<'_, String>

Gets the text value of a text span within a text block at a specific index in the flattened span list.

Panics if there is no span at the requested index.

Source

pub fn font(&mut self, root_entity: Entity, index: usize) -> Mut<'_, TextFont>

Gets the TextFont of a text span within a text block at a specific index in the flattened span list.

Panics if there is no span at the requested index.

Source

pub fn color(&mut self, root_entity: Entity, index: usize) -> Mut<'_, TextColor>

Gets the TextColor of a text span within a text block at a specific index in the flattened span list.

Panics if there is no span at the requested index.

Source

pub fn for_each( &mut self, root_entity: Entity, callback: impl FnMut(Entity, usize, Mut<'_, String>, Mut<'_, TextFont>, Mut<'_, TextColor>), )

Invokes a callback on each span in a text block, starting with the root entity.

Source

pub fn for_each_text( &mut self, root_entity: Entity, callback: impl FnMut(Mut<'_, String>), )

Invokes a callback on each span’s string value in a text block, starting with the root entity.

Source

pub fn for_each_font( &mut self, root_entity: Entity, callback: impl FnMut(Mut<'_, TextFont>), )

Invokes a callback on each span’s TextFont in a text block, starting with the root entity.

Source

pub fn for_each_color( &mut self, root_entity: Entity, callback: impl FnMut(Mut<'_, TextColor>), )

Invokes a callback on each span’s TextColor in a text block, starting with the root entity.

Source

pub fn for_each_until( &mut self, root_entity: Entity, callback: impl FnMut(Entity, usize, Mut<'_, String>, Mut<'_, TextFont>, Mut<'_, TextColor>) -> bool, )

Invokes a callback on each span in a text block, starting with the root entity.

Traversal will stop when the callback returns false.

Trait Implementations§

Source§

impl<R> SystemParam for TextWriter<'_, '_, R>
where R: TextRoot,

Source§

type State = FetchState<R>

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = TextWriter<'w, 's, R>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state( world: &mut World, ) -> <TextWriter<'_, '_, R> as SystemParam>::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &<TextWriter<'_, '_, R> as SystemParam>::State, system_meta: &mut SystemMeta, component_access_set: &mut FilteredAccessSet, world: &mut World, )

Registers any World access used by this SystemParam
Source§

fn apply( state: &mut <TextWriter<'_, '_, R> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut <TextWriter<'_, '_, R> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

unsafe fn validate_param<'w, 's>( state: &'s mut <TextWriter<'_, '_, R> as SystemParam>::State, _system_meta: &SystemMeta, _world: UnsafeWorldCell<'w>, ) -> Result<(), SystemParamValidationError>

Validates that the param can be acquired by the get_param. Read more
Source§

unsafe fn get_param<'w, 's>( state: &'s mut <TextWriter<'_, '_, R> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> <TextWriter<'_, '_, R> as SystemParam>::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction. Read more
Source§

impl<'w, 's, R> ReadOnlySystemParam for TextWriter<'w, 's, R>
where R: TextRoot, ResMut<'w, TextIterScratch>: ReadOnlySystemParam, Query<'w, 's, (&'static mut R, &'static mut TextFont, &'static mut TextColor), Without<TextSpan>>: ReadOnlySystemParam, Query<'w, 's, (&'static mut TextSpan, &'static mut TextFont, &'static mut TextColor), Without<R>>: ReadOnlySystemParam, Query<'w, 's, &'static Children>: ReadOnlySystemParam,

Auto Trait Implementations§

§

impl<'w, 's, R> Freeze for TextWriter<'w, 's, R>

§

impl<'w, 's, R> !RefUnwindSafe for TextWriter<'w, 's, R>

§

impl<'w, 's, R> Send for TextWriter<'w, 's, R>

§

impl<'w, 's, R> Sync for TextWriter<'w, 's, R>

§

impl<'w, 's, R> Unpin for TextWriter<'w, 's, R>

§

impl<'w, 's, R> !UnwindSafe for TextWriter<'w, 's, R>

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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
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
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,