microsandbox_core::config

Struct Sandbox

Source 
pub struct Sandbox { /* private fields */ }
Expand description

The sandbox to run.

Implementations§

Source§

impl Sandbox

Source

pub fn get_version(&self) -> &Option<Version>

The version of the sandbox.

Source

pub fn get_meta(&self) -> &Option<Meta>

The metadata about the sandbox.

Source

pub fn get_image(&self) -> &ReferenceOrPath

The image to use. This can be a path to a local rootfs or an OCI image reference.

Source

pub fn get_memory(&self) -> &Option<u32>

The amount of memory in MiB to use.

Source

pub fn get_cpus(&self) -> &Option<u8>

The number of vCPUs to use.

Source

pub fn get_volumes(&self) -> &Vec<PathPair>

The volumes to mount.

Source

pub fn get_ports(&self) -> &Vec<PortPair>

The ports to expose.

Source

pub fn get_envs(&self) -> &Vec<EnvPair>

The environment variables to use.

Source

pub fn get_groups(&self) -> &HashMap<String, SandboxGroup>

The groups to run in.

Source

pub fn get_depends_on(&self) -> &Vec<String>

The sandboxes to depend on.

Source

pub fn get_workdir(&self) -> &Option<Utf8UnixPathBuf>

The working directory to use.

Source

pub fn get_shell(&self) -> &Option<String>

The shell to use.

Source

pub fn get_scripts(&self) -> &HashMap<String, String>

The scripts that can be run.

Source

pub fn get_command(&self) -> &Vec<String>

The command to run. This is a list of command and arguments.

Source

pub fn get_imports(&self) -> &HashMap<String, Utf8UnixPathBuf>

The files to import.

Source

pub fn get_exports(&self) -> &HashMap<String, Utf8UnixPathBuf>

The artifacts produced by the sandbox.

Source

pub fn get_scope(&self) -> &NetworkScope

The network scope for the sandbox.

Source§

impl Sandbox

Source

pub fn set_version(&mut self, val: Option<Version>) -> &mut Self

The version of the sandbox.

Source

pub fn set_meta(&mut self, val: Option<Meta>) -> &mut Self

The metadata about the sandbox.

Source

pub fn set_image(&mut self, val: ReferenceOrPath) -> &mut Self

The image to use. This can be a path to a local rootfs or an OCI image reference.

Source

pub fn set_memory(&mut self, val: Option<u32>) -> &mut Self

The amount of memory in MiB to use.

Source

pub fn set_cpus(&mut self, val: Option<u8>) -> &mut Self

The number of vCPUs to use.

Source

pub fn set_volumes(&mut self, val: Vec<PathPair>) -> &mut Self

The volumes to mount.

Source

pub fn set_ports(&mut self, val: Vec<PortPair>) -> &mut Self

The ports to expose.

Source

pub fn set_envs(&mut self, val: Vec<EnvPair>) -> &mut Self

The environment variables to use.

Source

pub fn set_groups(&mut self, val: HashMap<String, SandboxGroup>) -> &mut Self

The groups to run in.

Source

pub fn set_depends_on(&mut self, val: Vec<String>) -> &mut Self

The sandboxes to depend on.

Source

pub fn set_workdir(&mut self, val: Option<Utf8UnixPathBuf>) -> &mut Self

The working directory to use.

Source

pub fn set_shell(&mut self, val: Option<String>) -> &mut Self

The shell to use.

Source

pub fn set_scripts(&mut self, val: HashMap<String, String>) -> &mut Self

The scripts that can be run.

Source

pub fn set_command(&mut self, val: Vec<String>) -> &mut Self

The command to run. This is a list of command and arguments.

Source

pub fn set_imports( &mut self, val: HashMap<String, Utf8UnixPathBuf>, ) -> &mut Self

The files to import.

Source

pub fn set_exports( &mut self, val: HashMap<String, Utf8UnixPathBuf>, ) -> &mut Self

The artifacts produced by the sandbox.

Source

pub fn set_scope(&mut self, val: NetworkScope) -> &mut Self

The network scope for the sandbox.

Source§

impl Sandbox

Source

pub fn builder() -> SandboxBuilder<()>

Returns a builder for the sandbox.

See SandboxBuilder for options.

Source

pub fn validate(&self) -> MicrosandboxResult<()>

Validates the configuration.

Trait Implementations§

Source§

impl Clone for Sandbox

Source§

fn clone(&self) -> Sandbox

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Sandbox

Source§

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

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

impl<'de> Deserialize<'de> for Sandbox

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 PartialEq for Sandbox

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Sandbox

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
Source§

impl StructuralPartialEq for Sandbox

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,