FirecrackerStartup

Struct FirecrackerStartup 

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

A structure for configuring the launch of FirecrackerVM. Helps to preconfigure and start the virtual machine.

Note: Firecracker must be installed globally.

Exemple:

let process = FirecrackerStartup::new()
    .set_api_socket("/tmp/some.socket")
    .download_rootfs(true)
    .download_kernel(true)
    .start().await.unwrap();

Implementations§

Source§

impl FirecrackerStartup

Source

pub fn new() -> Self

Creates a new instance of FirecrackerStartup

Source

pub fn set_api_socket<P: AsRef<Path>>(self, path: P) -> Self

Set the –api-sock startup argument with the path to the unix socket

Note: For the best documentation, please refer to here.

Source

pub fn get_api_socket(&self) -> &PathBuf

Returns the –api-sock startup argument with the path to the unix socket

Note: For the best documentation, please refer to here.

Source

pub fn download_kernel(self, flag: bool) -> Self

Flag to download the latest kernel version for microVM

Source

pub fn download_rootfs(self, flag: bool) -> Self

Flag to download the ubuntu-22.04.ext4 for microVM

Source

pub async fn start(self) -> Result<FirecrackerProcess>

Starts a VM with specified parameters Returns a structure for working with the Firecracker process

Trait Implementations§

Source§

impl Default for FirecrackerStartup

Source§

fn default() -> Self

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

impl Serialize for FirecrackerStartup

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

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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<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