Struct gapi_grpc::google::bytestream::WriteRequest

[+] Show declaration

pub struct WriteRequest {
    pub resource_name: String,
    pub write_offset: i64,
    pub finish_write: bool,
    pub data: Vec<u8>,
}

[−] Expand description

Request object for ByteStream.Write.

Fields

resource_name: String

[−] Expand description

The name of the resource to write. This must be set on the first WriteRequest of each Write() action. If it is set on subsequent calls, it must match the value of the first request.

write_offset: i64

[−] Expand description

The offset from the beginning of the resource at which the data should be written. It is required on all WriteRequests.

In the first WriteRequest of a Write() action, it indicates the initial offset for the Write() call. The value must be equal to the committed_size that a call to QueryWriteStatus() would return.

On subsequent calls, this value must be set and must be equal to the sum of the first write_offset and the sizes of all data bundles sent previously on this stream.

An incorrect value will cause an error.

finish_write: bool

[−] Expand description

If true, this indicates that the write is complete. Sending any WriteRequests subsequent to one in which finish_write is true will cause an error.

data: Vec<u8>

[−] Expand description

A portion of the data for the resource. The client may leave data empty for any given WriteRequest. This enables the client to inform the service that the request is still live while it is running an operation to generate more data.

Trait Implementations

impl Clone for WriteRequest[+]

[+] Show hidden undocumented items

fn clone(&self) -> WriteRequest[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for WriteRequest[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for WriteRequest[+]

[+] Show hidden undocumented items

fn default() -> WriteRequest[−]

Returns the “default value” for a type.

impl Message for WriteRequest[+]

[+] Show hidden undocumented items

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

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

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

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

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

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

impl PartialEq<WriteRequest> for WriteRequest[+]

[+] Show hidden undocumented items

fn eq(&self, other: &WriteRequest) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WriteRequest) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for WriteRequest