Struct CommandSpec

pub struct CommandSpec(/* private fields */);

Command specification that is cheap to clone

Implementations

impl CommandSpec

pub fn to_bytes(&self) -> Vec<u8>

Serializes the command specification into bytes in rkyv format.

Panics

Panics if rkyv doesn’t work properly.

pub fn from_bytes(bytes: &[u8]) -> CommandSpec

Deserializes the command specification from bytes in rkyv format.

pub unsafe fn from_bytes_unchecked(bytes: &[u8]) -> CommandSpec

Safety

The data source must be trusted and valid.

impl CommandSpec

pub fn new( commands: HashMap<String, CommandSpecItem, BuildHasherDefault<FxHasher>>, ) -> CommandSpec

Create a new command specification

pub fn get(&self, name: &str) -> Option<&CommandSpecItem>

Get an item by name

pub fn items(&self) -> impl Iterator<Item = (&str, &CommandSpecItem)>

Iterate all items

pub fn get_cmd(&self, name: &str) -> Option<&CmdShape>

Get an item by name in kind of command

pub fn get_env(&self, name: &str) -> Option<&EnvShape>

Get an item by name in kind of environment

Trait Implementations

impl Archive for CommandSpec

where Arc<CommandSpecRepr>: Archive,

type Archived = ArchivedCommandSpec

The archived representation of this type.

type Resolver = CommandSpecResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

unsafe fn resolve( &self, pos: usize, resolver: <CommandSpec as Archive>::Resolver, out: *mut <CommandSpec as Archive>::Archived, )

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for CommandSpec

fn clone(&self) -> CommandSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandSpec

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

Formats the value using the given formatter.

impl<__D> Deserialize<CommandSpec, __D> for <CommandSpec as Archive>::Archived

where __D: Fallible + ?Sized, Arc<CommandSpecRepr>: Archive, <Arc<CommandSpecRepr> as Archive>::Archived: Deserialize<Arc<CommandSpecRepr>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<CommandSpec, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl From<CommandSpecRepr> for CommandSpec

fn from(repr: CommandSpecRepr) -> CommandSpec

Converts to this type from the input type.

impl<__S> Serialize<__S> for CommandSpec

where __S: Fallible + ?Sized, Arc<CommandSpecRepr>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<CommandSpec as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.