Struct Vsock

pub struct Vsock {
    pub guest_cid: u32,
    pub uds_path: PathBuf,
    pub vsock_id: Option<String>,
}

Defines a vsock device, backed by a set of Unix Domain Sockets, on the host side. For host-initiated connections, Firecracker will be listening on the Unix socket identified by the path uds_path. Firecracker will create this socket, bind and listen on it. Host-initiated connections will be performed by connection to this socket and issuing a connection forwarding request to the desired guest-side vsock port (i.e. CONNECT 52\n, to connect to port 52). For guest-initiated connections, Firecracker will expect host software to be bound and listening on Unix sockets at uds_path_<PORT>. E.g. “/path/to/host_vsock.sock_52” for port number 52.

Fields

guest_cid: u32

Guest Vsock CID Required: true Minimum: 3 CID defines the 32-bit Context Identifier for the vsock device. See the vsock(7) manual page for more information.

uds_path: PathBuf

Path to UNIX domain socket, used to proxy vsock connections. Required: true Path defines the filesystem path of the vsock device on the host.

vsock_id: Option<String>

vsock id Required: true ID defines the vsock’s device ID for firecracker. This parameter has been deprecated and it will be removed in future Firecracker release.

Trait Implementations

impl Clone for Vsock

fn clone(&self) -> Vsock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vsock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Vsock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Vsock

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 Vsock

fn cmp(&self, other: &Vsock) -> 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.

impl PartialEq for Vsock

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Vsock

fn partial_cmp(&self, other: &Vsock) -> 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 Vsock

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Vsock

impl StructuralPartialEq for Vsock