Struct HttpBody 

#[non_exhaustive]
pub struct HttpBody {
    pub content_type: String,
    pub data: Bytes,
    pub extensions: Vec<Any>,
    /* private fields */
}

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can’t be represented as JSON, such as raw binary or an HTML page.

This message can be used both in streaming and non-streaming API methods in the request as well as the response.

It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.

Example:

message GetResourceRequest {
  // A unique request id.
  string request_id = 1;

  // The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

Example with streaming methods:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content_type: String

The HTTP Content-Type header value specifying the content type of the body.

data: Bytes

The HTTP request/response body as raw binary.

extensions: Vec<Any>

Application specific response metadata. Must be set in the first response for streaming APIs.

Implementations

impl HttpBody

pub fn new() -> Self

pub fn set_content_type<T: Into<String>>(self, v: T) -> Self

Sets the value of content_type.

pub fn set_data<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of data.

pub fn set_extensions<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Any>,

Sets the value of extensions.

Trait Implementations

impl Clone for HttpBody

fn clone(&self) -> HttpBody

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpBody

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

Formats the value using the given formatter.

impl Default for HttpBody

fn default() -> HttpBody

Returns the “default value” for a type.

impl Message for HttpBody

fn typename() -> &'static str

The typename of this message.

impl PartialEq for HttpBody

fn eq(&self, other: &HttpBody) -> 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 HttpBody