Skip to main content

MetadataRecorder

Struct MetadataRecorder 

Source
pub struct MetadataRecorder<const MAX_NODES: usize = DEFAULT_MAX_METADATA_NODES, const MAX_ENTITIES: usize = DEFAULT_MAX_METADATA_ENTITIES, const MAX_CALLBACKS: usize = DEFAULT_MAX_METADATA_CALLBACKS> { /* private fields */ }
Expand description

In-memory metadata sink used by host discovery. It never opens transport.

Implementations§

Source§

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

Source

pub const fn new() -> Self

Create an empty metadata recorder.

Source

pub fn nodes(&self) -> &[NodeMetadata]

Recorded nodes in declaration order.

Source

pub fn entities(&self) -> &[EntityMetadata]

Recorded entities in declaration order.

Source

pub fn callback_effects(&self) -> &[CallbackEffectMetadata]

Recorded optional callback effects in declaration order.

Source

pub fn to_source_metadata_json( &self, export: &SourceMetadataExport<'_>, ) -> Result<StdString, Error>

Emit schema-version-1 source metadata JSON without opening transport.

Source

pub fn write_source_metadata_json( &self, export: &SourceMetadataExport<'_>, out: &mut impl Write, ) -> Result

Write schema-version-1 source metadata JSON without opening transport.

Trait Implementations§

Source§

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> Debug for MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

Source§

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

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

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> Default for MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

Source§

fn default() -> Self

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

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> NodeRuntime for MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

Source§

fn create_node( &mut self, id: NodeId<'_>, options: NodeOptions<'_>, ) -> NodeResult<()>

Declare a component node.
Source§

fn create_entity(&mut self, metadata: EntityMetadata) -> NodeResult<()>

Declare a publisher, subscription, timer, service, action, or parameter.
Source§

fn record_callback_effect( &mut self, callback_id: CallbackId<'_>, kind: CallbackEffectKind, entity_id: EntityId<'_>, ) -> NodeResult<()>

Add optional callback effect metadata.

Auto Trait Implementations§

§

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> Freeze for MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

§

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> RefUnwindSafe for MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

§

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> Send for MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

§

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> Sync for MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

§

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> Unpin for MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

§

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> UnsafeUnpin for MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

§

impl<const MAX_NODES: usize, const MAX_ENTITIES: usize, const MAX_CALLBACKS: usize> UnwindSafe for MetadataRecorder<MAX_NODES, MAX_ENTITIES, MAX_CALLBACKS>

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