Skip to main content

LinuxRootfs

Struct LinuxRootfs 

Source
pub struct LinuxRootfs {
    pub init_binary: String,
    pub init_config: String,
    pub extra_files: Vec<InitrdFile>,
    pub busybox: Option<String>,
    pub sshd: Option<SshdSpec>,
    pub packages: Vec<GuestPackage>,
    pub name: String,
}
Expand description

The full recipe for a bootable initrd.

Fields§

§init_binary: String§init_config: String§extra_files: Vec<InitrdFile>§busybox: Option<String>

Bridge the busybox binary into the guest. Default: busybox from nixpkgs.

§sshd: Option<SshdSpec>

Optional sshd setup. When Some, the emitted runCommand pulls the full pkgs.openssh closure into root/nix/store/, symlinks /bin/sshd + /bin/ssh-keygen, generates a host key at build time, and writes /etc/ssh/{sshd_config, authorized_keys}. The caller is responsible for adding the sshd service to init_config.

§packages: Vec<GuestPackage>

Userspace packages to install in the guest. Each package’s closure is copied into root/nix/store/; bin entries land in /bin/.

§name: String

Name baked into the output derivation.

Implementations§

Source§

impl LinuxRootfs

Source

pub fn new( init_binary: impl Into<String>, init_config: impl Into<String>, ) -> Self

Source

pub fn with_name(self, n: impl Into<String>) -> Self

Source

pub fn with_file( self, path: impl Into<String>, content: impl Into<String>, ) -> Self

Source

pub fn with_file_from_store( self, path: impl Into<String>, store_path: impl Into<String>, ) -> Self

Source

pub fn without_busybox(self) -> Self

Source

pub fn with_sshd(self, spec: SshdSpec) -> Self

Bake openssh + sshd_config + authorized_keys + a generated ed25519 host key into the initrd.

Source

pub fn with_package(self, attr_path: impl Into<String>) -> Self

Add one userspace package. bin_names empty means “symlink every bin/* entry into /bin/”.

Source

pub fn with_packages<I, S>(self, attrs: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Add many packages at once.

Source

pub fn derivation(&self) -> Derivation

Produce the tatara Derivation whose realization is the initrd.cpio.gz.

Source

pub fn to_nix_expr(&self) -> String

Emit the full runCommand Nix expression.

Trait Implementations§

Source§

impl Default for LinuxRootfs

Source§

fn default() -> Self

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> GetSetFdFlags for T

Source§

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

Query the “status” flags for the self file descriptor.
Source§

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more
Source§

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: Sized + AsFilelike,

Set the “status” flags for the self file descriptor. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Pointer = u32

Source§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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