Struct fastly::handle::BodyHandle

#[repr(transparent)]pub struct BodyHandle { /* fields omitted */ }

A low-level interface to HTTP bodies.

This type implements Read to read bytes from the beginning of a body, and Write to write to the end of a body. Note that these operations are unbuffered, unlike the same operations on the higher-level Body type.

These handles can also be used to append bodies to each other in amortized constant time.

Implementations

impl BodyHandle

pub const INVALID: Self

An invalid body handle.

pub fn is_valid(&self) -> bool

Return true if the body handle is valid.

pub fn is_invalid(&self) -> bool

Return true if the body handle is invalid.

pub fn downstream_request() -> Self

👎 Deprecated since 0.6.0:

renamed to BodyHandle::from_client()

pub fn from_client() -> Self

Get a handle to the downstream request body.

This handle may only be retrieved once per execution, either through this function or through fastly::request::downstream_request_and_body_handles().

pub fn new() -> Self

Acquire a new BodyHandle.

pub fn append(&mut self, other: BodyHandle)

Append another body onto the end of this body.

The other body will no longer be valid after this call.

pub fn into_bytes(self) -> Vec<u8>

Read the entirety of the body.

Note that this will involve copying and buffering the body, and so should only be used for convenience on small request bodies.

pub fn into_string(self) -> String

Read the entirety of the body into a String, interpreting the bytes as UTF-8.

Note that this will involve copying and buffering the body, and so should only be used for convenience on small request bodies.

pub fn write_bytes(&mut self, bytes: &[u8]) -> usize

Write a slice of bytes to the end of this BodyHandle.

This function returns the number of bytes written.

body.write_bytes(&[0, 1, 2, 3]);

pub fn write_str(&mut self, string: &str) -> usize

Write a string slice to the end of this BodyHandle.

This function returns the number of bytes written.

body.write_str("woof woof");

Trait Implementations

impl Debug for BodyHandle

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

Formats the value using the given formatter.

impl Eq for BodyHandle

impl<'_> From<&'_ [u8]> for BodyHandle

fn from(s: &[u8]) -> Self

Performs the conversion.

impl<'_> From<&'_ str> for BodyHandle

fn from(s: &str) -> Self

Performs the conversion.

impl From<BodyHandle> for Body

fn from(handle: BodyHandle) -> Self

Performs the conversion.

impl From<String> for BodyHandle

fn from(s: String) -> Self

Performs the conversion.

impl From<Vec<u8>> for BodyHandle

fn from(s: Vec<u8>) -> Self

Performs the conversion.

impl Hash for BodyHandle

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<BodyHandle> for BodyHandle

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

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

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

This method tests for !=.

impl Read for BodyHandle

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl StructuralEq for BodyHandle

impl StructuralPartialEq for BodyHandle

impl Write for BodyHandle

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writeer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.