Skip to main content

BoxRecord

Struct BoxRecord 

Source
pub struct BoxRecord {
Show 59 fields pub id: String, pub short_id: String, pub name: String, pub image: String, pub isolation: ExecutionIsolation, pub managed_execution: Option<ManagedExecutionMetadata>, pub status: String, pub pid: Option<u32>, pub pid_start_time: Option<u64>, pub cpus: u32, pub memory_mb: u32, pub volumes: Vec<String>, pub virtiofs_cache: Option<String>, pub env: HashMap<String, String>, pub cmd: Vec<String>, pub entrypoint: Option<Vec<String>>, pub box_dir: PathBuf, pub exec_socket_path: PathBuf, pub console_log: PathBuf, pub created_at: DateTime<Utc>, pub started_at: Option<DateTime<Utc>>, pub auto_remove: bool, pub hostname: Option<String>, pub user: Option<String>, pub workdir: Option<String>, pub restart_policy: String, pub port_map: Vec<String>, pub labels: HashMap<String, String>, pub stopped_by_user: bool, pub restart_count: u32, pub max_restart_count: u32, pub exit_code: Option<i32>, pub health_check: Option<HealthCheck>, pub healthcheck_disabled: bool, pub health_status: String, pub health_retries: u32, pub health_last_check: Option<DateTime<Utc>>, pub network_mode: NetworkMode, pub network_name: Option<String>, pub volume_names: Vec<String>, pub tmpfs: Vec<String>, pub anonymous_volumes: Vec<String>, pub resource_limits: ResourceLimits, pub log_config: LogConfig, pub add_host: Vec<String>, pub platform: Option<String>, pub init: bool, pub read_only: bool, pub cap_add: Vec<String>, pub cap_drop: Vec<String>, pub security_opt: Vec<String>, pub privileged: bool, pub devices: Vec<String>, pub gpus: Option<String>, pub shm_size: Option<u64>, pub stop_signal: Option<String>, pub stop_timeout: Option<u64>, pub oom_kill_disable: bool, pub oom_score_adj: Option<i32>,
}
Expand description

Metadata record for a single local box execution.

Fields§

§id: String

Full UUID.

§short_id: String

First 12 hex characters of the UUID, without dashes.

§name: String

User-assigned or generated name.

§image: String

OCI image reference.

§isolation: ExecutionIsolation

Requested execution isolation. Records written before this field default to MicroVM.

§managed_execution: Option<ManagedExecutionMetadata>

Runtime lifecycle identity and recoverable creation intent.

Legacy CLI-created records omit this field. Managed executions persist it before launch so an operation can be reconciled after a service restart without creating a second execution.

§status: String

Persisted lifecycle state.

Legacy records use created, running, paused, stopped, and dead. Managed executions additionally use the durable transition states defined by ManagedExecutionState.

§pid: Option<u32>

Shim process PID while the execution is active.

§pid_start_time: Option<u64>

Start-time identity token used to reject a reused PID.

§cpus: u32

Number of virtual CPUs.

§memory_mb: u32

Memory in MiB.

§volumes: Vec<String>

Volume mounts encoded as host-to-guest pairs.

§virtiofs_cache: Option<String>

virtio-fs cache mode for host directory volumes.

§env: HashMap<String, String>

Environment variables.

§cmd: Vec<String>

Command override.

§entrypoint: Option<Vec<String>>

Entrypoint override.

§box_dir: PathBuf

Host-side execution directory.

§exec_socket_path: PathBuf

Path to the exec socket.

§console_log: PathBuf

Path to the console log.

§created_at: DateTime<Utc>

Creation timestamp.

§started_at: Option<DateTime<Utc>>

Start timestamp.

§auto_remove: bool

Whether the execution is removed automatically after it stops.

§hostname: Option<String>

Custom hostname.

§user: Option<String>

User inside the workload.

§workdir: Option<String>

Working directory inside the workload.

§restart_policy: String

Restart policy.

§port_map: Vec<String>

Port mappings.

§labels: HashMap<String, String>

User-defined labels.

§stopped_by_user: bool

Whether the execution was explicitly stopped by a user.

§restart_count: u32

Automatic restart count.

§max_restart_count: u32

Maximum restart count for a bounded on-failure policy.

§exit_code: Option<i32>

Last captured exit code.

§health_check: Option<HealthCheck>

Health-check configuration.

§healthcheck_disabled: bool

Whether an image-defined health check was disabled explicitly.

§health_status: String

Current health state.

§health_retries: u32

Consecutive health-check failures.

§health_last_check: Option<DateTime<Utc>>

Timestamp of the most recent health check.

§network_mode: NetworkMode

Network mode.

§network_name: Option<String>

Attached bridge network name.

§volume_names: Vec<String>

Attached named volumes.

§tmpfs: Vec<String>

tmpfs mounts.

§anonymous_volumes: Vec<String>

Anonymous volumes materialized from OCI declarations.

§resource_limits: ResourceLimits

Host resource controls.

§log_config: LogConfig

Logging configuration.

§add_host: Vec<String>

Custom host-to-IP mappings.

§platform: Option<String>

Target OCI platform.

§init: bool

Whether to run an init process as PID 1.

§read_only: bool

Whether the root filesystem is read-only.

§cap_add: Vec<String>

Added Linux capabilities.

§cap_drop: Vec<String>

Dropped Linux capabilities.

§security_opt: Vec<String>

OCI security options.

§privileged: bool

Whether extended privileges are enabled.

§devices: Vec<String>

Device mappings.

§gpus: Option<String>

GPU selection.

§shm_size: Option<u64>

Shared-memory size in bytes.

§stop_signal: Option<String>

Signal used for graceful stop.

§stop_timeout: Option<u64>

Graceful stop timeout in seconds.

§oom_kill_disable: bool

Whether the OOM killer is disabled.

§oom_score_adj: Option<i32>

Host OOM score adjustment.

Implementations§

Source§

impl BoxRecord

Source

pub fn make_short_id(id: &str) -> String

Generate the stable short ID used by local CLI and SDK lookup.

Source

pub fn is_active(&self) -> bool

Whether the persisted lifecycle state represents an active execution.

Source

pub fn managed_state(&self) -> Result<Option<ManagedExecutionState>>

Parse the lifecycle state of a managed execution.

Legacy records return None. Unknown managed states fail closed so a runtime service cannot operate on a record written by incompatible code.

Source

pub fn status_summary(&self) -> String

Render a concise lifecycle status with health, exit, and restart annotations.

Trait Implementations§

Source§

impl Clone for BoxRecord

Source§

fn clone(&self) -> BoxRecord

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BoxRecord

Source§

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

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

impl<'de> Deserialize<'de> for BoxRecord

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 Serialize for BoxRecord

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_base64<Input>(raw: &Input) -> Result<T, Error>
where Input: AsRef<[u8]> + ?Sized,

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<C> SignWithKey<String> for C
where C: ToBase64,

Source§

impl<T> ToBase64 for T
where T: Serialize,

Source§

fn to_base64(&self) -> Result<Cow<'_, str>, Error>

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