Struct VmId 

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

The identity of a VM: a plain name — non-empty, at most 64 characters, and [A-Za-z0-9-].

Drivers use it as a runtime-directory and socket-name component, and hand it to the VMM as the instance id it runs under. The alphabet is therefore the intersection of what those uses allow, not the union: Firecracker validates its --id as [A-Za-z0-9-], 1..=64, and panics on anything else — Invalid instance ID: InvalidChar('_', 4), raised from inside whatever task spawned the VMM, with nothing tying it back to the request that supplied the id. A separator this type accepted but a driver could not run would be a promise the port cannot keep, so it accepts only -. MAX_LEN is that same VMM-imposed 64.

A driver-internal name that never becomes a VMM identity — DiskSpec::id is the one here — keeps the wider path-safe alphabet (. and _ too).

Implementations

impl VmId

pub const MAX_LEN: usize = 64

The longest id a driver has to fit into a path or socket name, and the longest a VMM will take as its instance id.

pub fn new(id: impl Into<String>) -> Result<Self>

Validates id and wraps it.

pub fn as_str(&self) -> &str

The id as text.

Trait Implementations

impl AsRef<str> for VmId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for VmId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VmId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VmId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VmId

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

Formats the value using the given formatter.

impl Eq for VmId

impl From<VmId> for String

fn from(id: VmId) -> Self

Converts to this type from the input type.

impl Hash for VmId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for VmId

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for VmId

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for VmId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for VmId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VmId

impl TryFrom<String> for VmId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.