Struct blobfs::Client

source ·
pub struct Client { /* private fields */ }
Expand description

Blobfs client

Implementations§

source§

impl Client

source

pub fn open_from_namespace() -> Result<Self, BlobfsError>

Returns an client connected to blobfs from the current component’s namespace.

source

pub fn open_from_namespace_executable() -> Result<Self, BlobfsError>

Returns a client connected to blobfs from the current component’s namespace with OPEN_RIGHT_READABLE and OPEN_RIGHT_EXECUTABLE.

source

pub fn open_from_namespace_rwx() -> Result<Self, BlobfsError>

Returns a client connected to blobfs from the current component’s namespace with OPEN_RIGHT_READABLE, OPEN_RIGHT_WRITABLE, OPEN_RIGHT_EXECUTABLE.

source

pub fn new(proxy: DirectoryProxy) -> Self

Returns an client connected to blobfs from the given blobfs root dir.

source

pub fn new_test() -> (Self, DirectoryRequestStream)

Creates a new client backed by the returned request stream. This constructor should not be used outside of tests.

Panics

Panics on error

source

pub fn new_mock() -> (Self, Mock)

Creates a new client backed by the returned mock. This constructor should not be used outside of tests.

Panics

Panics on error

source

pub fn new_temp_dir_fake() -> (Self, TempDirFake)

Creates a new read-only client backed by the returned TempDirFake. TempDirFake is a thin wrapper around a tempfile::TempDir and therefore does not replicate many of the important properties of blobfs, including:

  • requiring truncate before write
  • requiring file names be hashes of contents

This should therefore generally only be used to test read-only clients of blobfs (i.e. tests in which only the test harness itself is writing to blobfs and the code-under-test is only reading from blobfs).

To help enforce this, the DirectoryProxy used to create the Client is opened with only OPEN_RIGHT_READABLE.

Requires a RW directory at “/tmp” in the component namespace.

This constructor should not be used outside of tests.

Panics

Panics on error

source

pub fn forward_open( &self, blob: &Hash, flags: OpenFlags, server_end: ServerEnd<NodeMarker> ) -> Result<(), Error>

Forward an open request directly to BlobFs.

source

pub async fn list_known_blobs(&self) -> Result<HashSet<Hash>, BlobfsError>

Returns the list of known blobs in blobfs.

source

pub async fn delete_blob(&self, blob: &Hash) -> Result<(), BlobfsError>

Delete the blob with the given merkle hash.

source

pub async fn open_blob_for_read( &self, blob: &Hash ) -> Result<FileProxy, OpenError>

Open the blob for reading.

source

pub fn open_blob_for_read_no_describe( &self, blob: &Hash ) -> Result<FileProxy, OpenError>

Open the blob for reading. The target is not verified to be any particular type and may not implement the fuchsia.io.File protocol.

source

pub async fn open_blob_for_write( &self, blob: &Hash, blob_type: BlobType ) -> Result<Blob<NeedsTruncate>, CreateError>

Open a new blob for write.

source

pub async fn has_blob(&self, blob: &Hash) -> bool

Returns whether blobfs has a blob with the given hash.

source

pub async fn filter_to_missing_blobs( &self, candidates: &HashSet<Hash> ) -> HashSet<Hash>

Determines which of candidate blobs exist and are readable in blobfs, returning the set difference of candidates and readable.

source

pub async fn sync(&self) -> Result<(), BlobfsError>

Call fuchsia.io/Node.Sync on the blobfs directory.

Trait Implementations§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Encode<Ambiguous1> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> Encode<Ambiguous2> for T

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

const: unstable · 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 Twhere U: From<T>,

const: unstable · 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

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

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

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

§

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