Struct WriteContentRequest

pub struct WriteContentRequest {
    pub action: i32,
    pub ref: String,
    pub total: i64,
    pub expected: String,
    pub offset: i64,
    pub data: Vec<u8>,
    pub labels: HashMap<String, String>,
}

WriteContentRequest writes data to the request ref at offset.

Fields

action: i32

Action sets the behavior of the write.

When this is a write and the ref is not yet allocated, the ref will be allocated and the data will be written at offset.

If the action is write and the ref is allocated, it will accept data to an offset that has not yet been written.

If the action is write and there is no data, the current write status will be returned. This works differently from status because the stream holds a lock.

ref: String

Ref identifies the pre-commit object to write to.

total: i64

Total can be set to have the service validate the total size of the committed content.

The latest value before or with the commit action message will be use to validate the content. If the offset overflows total, the service may report an error. It is only required on one message for the write.

If the value is zero or less, no validation of the final content will be performed.

expected: String

Expected can be set to have the service validate the final content against the provided digest.

If the digest is already present in the object store, an AlreadyExists error will be returned.

Only the latest version will be used to check the content against the digest. It is only required to include it on a single message, before or with the commit action message.

offset: i64

Offset specifies the number of bytes from the start at which to begin the write. For most implementations, this means from the start of the file. This uses standard, zero-indexed semantics.

If the action is write, the remote may remove all previously written data after the offset. Implementations may support arbitrary offsets but MUST support reseting this value to zero with a write. If an implementation does not support a write at a particular offset, an OutOfRange error must be returned.

data: Vec<u8>

Data is the actual bytes to be written.

If this is empty and the message is not a commit, a response will be returned with the current write state.

labels: HashMap<String, String>

Labels are arbitrary data on snapshots.

The combined size of a key/value pair cannot exceed 4096 bytes.

Implementations

impl WriteContentRequest

pub fn action(&self) -> WriteAction

Returns the enum value of action, or the default if the field is set to an invalid enum value.

pub fn set_action(&mut self, value: WriteAction)

Sets action to the provided enum value.

Trait Implementations

impl Clone for WriteContentRequest

fn clone(&self) -> WriteContentRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WriteContentRequest

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

Formats the value using the given formatter.

impl Default for WriteContentRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for WriteContentRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for WriteContentRequest

const NAME: &'static str = "WriteContentRequest"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "containerd.services.content.v1"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for WriteContentRequest

fn eq(&self, other: &WriteContentRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WriteContentRequest