Struct VmgsClient 

pub struct VmgsClient { /* private fields */ }

Client to interact with a backend-agnostic VMGS instance.

Implementations

impl VmgsClient

pub async fn get_file_info( &self, file_id: FileId, ) -> Result<VmgsFileInfo, VmgsClientError>

Get allocated and valid bytes from File Control Block for file_id.

pub async fn read_file( &self, file_id: FileId, ) -> Result<Vec<u8>, VmgsClientError>

Reads the specified file_id.

pub async fn write_file( &self, file_id: FileId, buf: Vec<u8>, ) -> Result<(), VmgsClientError>

Writes buf to a file_id.

NOTE: It is an error to overwrite a previously encrypted FileId with plaintext data.

pub async fn write_file_encrypted( &self, file_id: FileId, buf: Vec<u8>, ) -> Result<(), VmgsClientError>

If VMGS has been configured with encryption, encrypt + write bug to the specified file_id. Otherwise, perform a regular plaintext write instead.

pub async fn save(&self) -> Result<SavedVmgsState, VmgsClientError>

Save the in-memory VMGS file metadata.

This saved state can be used alongside open_from_saved to obtain a new Vmgs instance without needing to invoke any IOs on the underlying storage.

Trait Implementations

impl CanResolveTo<VmgsClient> for VmgsClientKind

type Input<'a> = ()

Additional input (besides the resource itself) when resolving resources of this resource kind.

impl Clone for VmgsClient

fn clone(&self) -> VmgsClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DefaultEncoding for VmgsClient

type Encoding = TableEncoder

The encoding to use for the serialization.

impl Inspect for VmgsClient

fn inspect(&self, req: Request<'_>)

Inspects the object.

impl ResolveResource<VmgsClientKind, PlatformResource> for VmgsClient

type Output = VmgsClient

The output type for resource resolution.

type Error = Infallible

The error type for resolve.

fn resolve( &self, PlatformResource: PlatformResource, (): (), ) -> Result<Self::Output, Self::Error>

Resolves the resource.

impl<'encoding> StructDecodeMetadata<'encoding, Resource> for VmgsClient

const DECODERS: &'static [ErasedDecoderEntry]

The list of decoder vtables.

impl StructEncodeMetadata<Resource> for VmgsClient

const ENCODERS: &'static [ErasedEncoderEntry]

The list of encoder vtables.

impl StructMetadata for VmgsClient

const NUMBERS: &'static [u32]

The field numbers for each field.

const OFFSETS: &'static [usize]

The byte offset to each field within the struct.