Trait opensearch::http::request::Body

pub trait Body {
    // Required method
    fn write(&self, bytes: &mut BytesMut) -> Result<(), Error>;

    // Provided method
    fn bytes(&self) -> Option<Bytes> { ... }
}

Body of an API call.

Some Elasticsearch APIs accept a body as part of the API call. Most APIs expect JSON, however, there are some APIs that expect newline-delimited JSON (NDJSON). The Body trait allows modelling different API body implementations.

Required Methods

fn write(&self, bytes: &mut BytesMut) -> Result<(), Error>

Write to a buffer that will be written to the request stream

Provided Methods

fn bytes(&self) -> Option<Bytes>

An existing immutable buffer that can be used to avoid having to write to another buffer that will then be written to the request stream.

If this method returns Some, the bytes must be the same as those that would be written by Body::write.

Implementations on Foreign Types

impl Body for ()

fn write(&self, _bytes: &mut BytesMut) -> Result<(), Error>

impl Body for String

fn write(&self, bytes: &mut BytesMut) -> Result<(), Error>

impl Body for Vec<u8>

fn write(&self, bytes: &mut BytesMut) -> Result<(), Error>

impl Body for Bytes

fn bytes(&self) -> Option<Bytes>

fn write(&self, bytes: &mut BytesMut) -> Result<(), Error>

impl Body for BytesMut

fn bytes(&self) -> Option<Bytes>

fn write(&self, bytes: &mut BytesMut) -> Result<(), Error>

impl<'a> Body for &'a str

fn write(&self, bytes: &mut BytesMut) -> Result<(), Error>

impl<'a> Body for &'a [u8]

fn write(&self, bytes: &mut BytesMut) -> Result<(), Error>

impl<'a, B> Body for &'a B

where B: Body + ?Sized,

fn bytes(&self) -> Option<Bytes>

fn write(&self, bytes: &mut BytesMut) -> Result<(), Error>

Implementors

impl Body for BulkOperations

impl<B> Body for BulkOperation<B>

where B: Serialize,

impl<T> Body for JsonBody<T>

where T: Serialize,

impl<T> Body for NdBody<T>

where T: Body,