Struct SnapshotServiceClient

pub struct SnapshotServiceClient<T> { /* private fields */ }

A service that provides the ability to export and import the state of the system for backup and migration purposes.

Note that the data exported and imported is not guaranteed to be compatible across implementations, some systems may export only a subset of the data, others may import only a subset of the data. This is especially important when jobs are being executed during the export and import process.

Implementations

impl SnapshotServiceClient<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> SnapshotServiceClient<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, ) -> SnapshotServiceClient<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 export( &mut self, request: impl IntoRequest<ExportRequest>, ) -> Result<Response<Streaming<ExportResponse>>, Status>

Export all the data of the system.

pub async fn import( &mut self, request: impl IntoStreamingRequest<Message = ImportRequest>, ) -> Result<Response<ImportResponse>, Status>

Import the full snapshot of the system.

Note that this may overwrite the existing state of the system depending on the implementation.

Trait Implementations

impl<T: Clone> Clone for SnapshotServiceClient<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SnapshotServiceClient<T>

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

Formats the value using the given formatter.