Skip to main content

SeedApiRuntime

Struct SeedApiRuntime 

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

The Seed runtime adapter.

Implementations§

Source§

impl SeedApiRuntime

Source

pub fn new( cfg: SeedConfig, transport: Arc<dyn SeedTransport>, creds: Arc<dyn SeedCredentials>, ) -> Result<Self, RuntimeError>

New adapter. Refuses a malformed node id or pin.

Source§

impl SeedApiRuntime

Source

pub fn node_id(&self) -> &str

This adapter’s operator-assigned node id.

Source

pub async fn identity(&self) -> Result<(String, String), RuntimeError>

The Seed’s own (device_id, public_key) from GET /api/v1/identity.

Source§

impl SeedApiRuntime

Source

pub async fn installed(&self) -> Result<Vec<InstalledCog>, RuntimeError>

Installed cogs (GET /api/v1/apps).

Source

pub async fn stop_cog(&self, id: &str) -> Result<(), RuntimeError>

Stop a cog by id (POST /api/v1/apps/{id}/stop).

Source

pub async fn start_cog(&self, id: &str) -> Result<(), RuntimeError>

Start a cog by id (POST /api/v1/apps/{id}/start).

Source§

impl SeedApiRuntime

Source

pub async fn pair( &self, client_name: &str, bootstrap: &SecretString, ) -> Result<(), RuntimeError>

Pair with the Seed: open the pairing window (authorized by bootstrap, which may be empty over the trusted USB link), request a client token, and store it in the operator secret store.

Source

pub async fn writes_gated(&self) -> Result<bool, RuntimeError>

Current writes_gated flag from /api/v1/status.

Source

pub async fn backup(&self, dir: &Path) -> Result<SeedBackup, RuntimeError>

Snapshot status, identity, installed apps, each app’s config and the witness chain into a new private directory dir.

Source

pub async fn check_backup( &self, backup: &SeedBackup, same_firmware: bool, ) -> Result<String, RuntimeError>

Verify backup and check it was taken from this Seed: same operator node id, and the Seed’s current identity has the same device id and public key. With same_firmware, the firmware must also be unchanged (the backup reflects the state about to be upgraded). Returns the current firmware version.

Source

pub async fn upgrade_firmware( &self, backup: &SeedBackup, target_version: &str, ) -> Result<UpgradeOutcome, RuntimeError>

Apply the pending firmware upgrade, but only if it is the version the operator pinned (target_version). Refuses without a verified backup of this Seed at its current firmware, while writes are gated, or when the Seed does not report which version is pending.

Source

pub async fn recover_writes_gated( &self, backup: &SeedBackup, ) -> Result<(), RuntimeError>

Recover the witness-chain writes_gated state. Only runs when the Seed reports writes gated and backup still verifies.

Trait Implementations§

Source§

impl WorkloadRuntime for SeedApiRuntime

Source§

fn network_exposure(&self) -> NetworkPolicy

The Seed firmware, not WeftOS, decides what its cogs can reach; the Seed has internet access, so the gate is told egress.

Source§

fn console_preemptions<'life0, 'life1, 'async_trait>( &'life0 self, h: &'life1 InstanceHandle, ) -> Pin<Box<dyn Future<Output = Result<Vec<Preemption>, RuntimeError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Every running cog, including ones WeftOS did not load (UDP 5006 contention: any listener on the Seed competes for the feed).

Source§

fn id(&self) -> &str

Adapter id (native, container.docker, remote.api.cognitum-seed).
Source§

fn provides(&self) -> Vec<Capability>

Capabilities a node advertises when this adapter works.
Source§

fn admit<'life0, 'life1, 'async_trait>( &'life0 self, w: &'life1 VerifiedWorkload, ) -> Pin<Box<dyn Future<Output = Result<Admission, RuntimeError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Self-check: can this node run w? Reserves nothing it cannot undo.
Source§

fn load<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, w: &'life1 VerifiedWorkload, cfg: &'life2 WorkloadConfig, ) -> Pin<Box<dyn Future<Output = Result<InstanceHandle, RuntimeError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Stage the payload and config; returns a handle for the instance.
Source§

fn adopt<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, h: &'life1 InstanceHandle, w: &'life2 VerifiedWorkload, ) -> Pin<Box<dyn Future<Output = Result<(), RuntimeError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Re-attach an instance this adapter loaded before the controller restarted (its in-memory table is gone but the device still holds it). The adapter verifies the instance is still there and still the pinned version, so stop / unload work again; it starts and changes nothing on the device.
Source§

fn start<'life0, 'life1, 'async_trait>( &'life0 self, h: &'life1 InstanceHandle, ) -> Pin<Box<dyn Future<Output = Result<(), RuntimeError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Start the instance.
Source§

fn stop<'life0, 'life1, 'async_trait>( &'life0 self, h: &'life1 InstanceHandle, _grace: Duration, ) -> Pin<Box<dyn Future<Output = Result<RunEvidence, RuntimeError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Stop it (terminate, then kill after grace) and return evidence.
Source§

fn unload<'life0, 'async_trait>( &'life0 self, h: InstanceHandle, ) -> Pin<Box<dyn Future<Output = Result<(), RuntimeError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Remove staged payload and state.
Source§

fn status<'life0, 'life1, 'async_trait>( &'life0 self, h: &'life1 InstanceHandle, ) -> Pin<Box<dyn Future<Output = InstanceStatus> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Current status.
Source§

fn control_mode(&self) -> ControlMode

Managed or adopted.
How the link to a remote device is authenticated. Fails closed: only a remote adapter with a pinned transport says Pinned.
Source§

fn preempt<'life0, 'life1, 'async_trait>( &'life0 self, p: &'life1 Preemption, ) -> Pin<Box<dyn Future<Output = Result<(), RuntimeError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Stop one preempted instance.
Source§

fn resume<'life0, 'life1, 'async_trait>( &'life0 self, p: &'life1 Preemption, ) -> Pin<Box<dyn Future<Output = Result<(), RuntimeError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Restart one preempted instance after the console run.
Source§

fn console<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, h: &'life1 InstanceHandle, command: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<RunEvidence, RuntimeError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Run one console cycle ([console] limits apply). command must be one of the cog’s [console].allowed_commands.
Source§

fn staged_payload<'life0, 'life1, 'async_trait>( &'life0 self, _h: &'life1 InstanceHandle, ) -> Pin<Box<dyn Future<Output = Option<PathBuf>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The file an instance’s binary was staged to, when the adapter runs it from disk (the licence run gate rehashes it at each start). None: not run from a file this node can read (a container image is tagged by the binary’s BLAKE3; a remote device holds its own copy).

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> 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> 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<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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