Skip to main content

StorageService

Struct StorageService 

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

Authenticated Storage Service handle.

Wraps a PushService plus the short-lived basic-auth credentials and the account StorageServiceKey, so callers get decrypted protobufs straight out and never touch the wire crypto themselves.

Implementations§

Source§

impl StorageService

Source

pub async fn new( service: PushService, storage_key: StorageServiceKey, ) -> Result<Self, ServiceError>

Authenticate against the storage service.

Fetches a fresh basic-auth token (GET /v1/storage/auth); the token is good for ~24h server-side but cheap enough to re-fetch per sync.

Source

pub async fn manifest(&self) -> Result<ManifestRecord, StorageServiceError>

Fetch and decrypt the latest manifest.

Source

pub async fn manifest_if_changed( &self, version: u64, ) -> Result<Option<ManifestRecord>, StorageServiceError>

Fetch and decrypt the manifest only if the server’s version differs from version. Ok(None) means the server matched (HTTP 204).

Source

pub async fn read_items( &self, keys: Vec<Vec<u8>>, record_ikm: Option<&[u8]>, ) -> Result<Vec<StorageRecord>, StorageServiceError>

Fetch and decrypt storage items by key.

keys are Identifier.raw blobs from ManifestRecord::identifiers; record_ikm is ManifestRecord::record_ikm (empty on legacy accounts, in which case the per-item key is derived from the storage key directly). Items the server doesn’t return are simply absent from the result.

Source

pub fn decrypt_manifest( storage_key: &StorageServiceKey, manifest: &StorageManifest, ) -> Result<ManifestRecord, StorageServiceError>

Decrypt a StorageManifest into a ManifestRecord.

Source

pub fn encrypt_manifest( storage_key: &StorageServiceKey, record: &ManifestRecord, ) -> StorageManifest

Encrypt a ManifestRecord into a StorageManifest ready to PUT.

Source

pub fn decrypt_item( storage_key: &StorageServiceKey, item: &StorageItem, record_ikm: Option<&[u8]>, ) -> Result<StorageRecord, StorageServiceError>

Decrypt a StorageItem into a StorageRecord.

Source

pub fn encrypt_item( storage_key: &StorageServiceKey, raw_id: Vec<u8>, record: &StorageRecord, record_ikm: Option<&[u8]>, ) -> StorageItem

Encrypt a StorageRecord into a StorageItem ready to PUT.

raw_id is the item’s identifier; record_ikm should match what’s in the manifest this item will be referenced from.

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
§

impl<T> Classify for T

§

type Classified = T

§

fn classify(self) -> T

§

impl<T> Declassify for T

§

type Declassified = T

§

fn declassify(self) -> T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. 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
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> PolicyExt for T
where T: ?Sized,

§

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
§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
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