Struct ImagesClient

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

Images is a service that allows one to register images with containerd.

In containerd, an image is merely the mapping of a name to a content root, described by a descriptor. The behavior and state of image is purely dictated by the type of the descriptor.

From the perspective of this service, these references are mostly shallow, in that the existence of the required content won’t be validated until required by consuming services.

As such, this can really be considered a “metadata service”.

Implementations

impl ImagesClient<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> ImagesClient<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, ) -> ImagesClient<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<GetImageRequest>, ) -> Result<Response<GetImageResponse>, Status>

Get returns an image by name.

pub async fn list( &mut self, request: impl IntoRequest<ListImagesRequest>, ) -> Result<Response<ListImagesResponse>, Status>

List returns a list of all images known to containerd.

pub async fn create( &mut self, request: impl IntoRequest<CreateImageRequest>, ) -> Result<Response<CreateImageResponse>, Status>

Create an image record in the metadata store.

The name of the image must be unique.

pub async fn update( &mut self, request: impl IntoRequest<UpdateImageRequest>, ) -> Result<Response<UpdateImageResponse>, Status>

Update assigns the name to a given target image based on the provided image.

pub async fn delete( &mut self, request: impl IntoRequest<DeleteImageRequest>, ) -> Result<Response<()>, Status>

Delete deletes the image by name.

Trait Implementations

impl<T: Clone> Clone for ImagesClient<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ImagesClient<T>

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

Formats the value using the given formatter.