Skip to main content

StorageEngine

Struct StorageEngine 

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

Thread-safe, lazily-initialised storage engine.

The engine owns the ObjectStore adapter and exposes the asset-ingestion pipeline. It is Send + Sync and designed to be stored in a global OnceLock so that FFI bindings can access it without constructing their own instance.

Implementations§

Source§

impl StorageEngine

Source

pub fn from_env() -> StorageResult<Self>

Construct the engine from environment variables.

§Environment Variables
VariableUsed byPurpose
NAP_STORAGE_BACKENDbothlocal (default) or s3
NAP_DIRlocalBase directory (default: ~/.nap)
NAP_S3_BUCKETs3S3 bucket name (required)
AWS_ACCESS_KEY_IDs3AWS / R2 access key
AWS_SECRET_ACCESS_KEYs3AWS / R2 secret key
AWS_REGIONs3AWS region (e.g. us-east-1)
AWS_ENDPOINT_URL_S3s3Custom S3 endpoint (R2, MinIO)
AWS_ENDPOINT_URLs3Fallback if AWS_ENDPOINT_URL_S3 unset
Source

pub fn config(&self) -> &StorageConfig

Return the active configuration.

Source

pub fn store(&self) -> &dyn ObjectStore

Return a reference to the underlying ObjectStore.

Source

pub async fn ingest_media( &self, data: &[u8], format: &str, ) -> StorageResult<String>

Ingest media bytes into the content-addressed store.

This is the core ingestion pipeline:

  1. Hash — Compute sha256:<hex> from the byte slice.
  2. Idempotency check — Send a HEAD request to see if the blob already exists. If it does, return the hash immediately without any network / disk write.
  3. PUT — Upload the bytes as <hex>.<format> under the assets prefix (.nap-assets/ for both backends).
§Arguments
  • data — Raw media bytes (image, audio, mesh, etc.).
  • format — File extension without leading dot (e.g. "png", "jpg", "wav", "glb").
§Returns

The content-addressed hash string sha256:<hex>.

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