Struct tvix_castore::proto::directory_service_client::DirectoryServiceClient

pub struct DirectoryServiceClient<T> {
    inner: Grpc<T>,
}

Fields

inner: Grpc<T>

Implementations

impl DirectoryServiceClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error>

where D: TryInto<Endpoint>, D::Error: Into<StdError>,

Attempt to create a new client by connecting to a given endpoint.

impl<T> DirectoryServiceClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> DirectoryServiceClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn get( &mut self, request: impl IntoRequest<GetDirectoryRequest>, ) -> Result<Response<Streaming<Directory>>, Status>

Get retrieves a stream of Directory messages, by using the lookup parameters in GetDirectoryRequest. Keep in mind multiple DirectoryNodes in different parts of the graph might have the same digest if they have the same underlying contents, so sending subsequent ones can be omitted.

It is okay for certain implementations to only allow retrieval of Directory digests that are at the “root”, aka the last element that’s sent in a Put. This makes sense for implementations bundling closures of directories together in batches.

pub async fn put( &mut self, request: impl IntoStreamingRequest<Message = Directory>, ) -> Result<Response<PutDirectoryResponse>, Status>

Put uploads a graph of Directory messages. Individual Directory messages need to be send in an order walking up from the leaves to the root - a Directory message can only refer to Directory messages previously sent in the same stream. Keep in mind multiple DirectoryNodes in different parts of the graph might have the same digest if they have the same underlying contents, so sending subsequent ones can be omitted. We might add a separate method, allowing to send partial graphs at a later time, if requiring to send the full graph turns out to be a problem.

Trait Implementations

impl<T: Clone> Clone for DirectoryServiceClient<T>

fn clone(&self) -> DirectoryServiceClient<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DirectoryServiceClient<T>

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

Formats the value using the given formatter.