Skip to main content

SerializedInterfaceDeclaration

Struct SerializedInterfaceDeclaration 

Source
pub struct SerializedInterfaceDeclaration<ConfigType> { /* private fields */ }
Expand description

Append-only builder for a serialized UI declaration instruction stream.

Use the builder methods to record operations in the same order they occur during live UI construction. The resulting stream can be serialized to JSON via LeafedInterfaceDeclaration::store_in.

§Examples

let mut decl = SerializedInterfaceDeclaration::<MyConfig>::new();
decl.start();
decl.open();
decl.add_config(my_config);
decl.close();
decl.end();

Implementations§

Source§

impl<Config> SerializedInterfaceDeclaration<Config>

Source

pub fn new() -> Self

Creates an empty declaration with no recorded instructions.

Source

pub fn start(&mut self)

Records a Start marker.

Source

pub fn end(&mut self)

Records an End marker.

Source

pub fn open(&mut self)

Records an Open instruction.

Source

pub fn add_config(&mut self, config: Config)

Records a Configure instruction.

Source

pub fn close(&mut self)

Records a Close instruction.

Source

pub fn add_leaf_config<LeafConfig: Serialize>(&mut self, config: &LeafConfig)

Records a LeafConfig instruction.

Source

pub fn iter_over( &self, ) -> impl Iterator<Item = &SerializableInterfaceInstructions<Config>>

Iterates over the recorded instructions in order.

Trait Implementations§

Source§

impl<ConfigType: Debug> Debug for SerializedInterfaceDeclaration<ConfigType>

Source§

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

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

impl<Config> Default for SerializedInterfaceDeclaration<Config>

Source§

fn default() -> Self

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

impl<'de, ConfigType> Deserialize<'de> for SerializedInterfaceDeclaration<ConfigType>
where ConfigType: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<ConfigType> Serialize for SerializedInterfaceDeclaration<ConfigType>
where ConfigType: Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<ConfigType> Freeze for SerializedInterfaceDeclaration<ConfigType>

§

impl<ConfigType> RefUnwindSafe for SerializedInterfaceDeclaration<ConfigType>
where ConfigType: RefUnwindSafe,

§

impl<ConfigType> Send for SerializedInterfaceDeclaration<ConfigType>
where ConfigType: Send,

§

impl<ConfigType> Sync for SerializedInterfaceDeclaration<ConfigType>
where ConfigType: Sync,

§

impl<ConfigType> Unpin for SerializedInterfaceDeclaration<ConfigType>
where ConfigType: Unpin,

§

impl<ConfigType> UnsafeUnpin for SerializedInterfaceDeclaration<ConfigType>

§

impl<ConfigType> UnwindSafe for SerializedInterfaceDeclaration<ConfigType>
where ConfigType: UnwindSafe,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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