Struct fastly::handle::StreamingBodyHandle

#[repr(transparent)]
pub struct StreamingBodyHandle { /* private fields */ }

A low-level interface to a streaming HTTP body.

The interface to this type is very similar to BodyHandle, however it is write-only, and can only be created as a result of calling ResponseHandle::send_to_client() or RequestHandle::send_async_streaming().

This type implements 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.

A streaming body will be automatically closed when it goes out of scope, or when it is passed to drop().

Implementations

impl StreamingBodyHandle

pub fn from_body_handle(body_handle: BodyHandle) -> Self

Make a streaming body handle from a non-streaming handle.

This should only be used when calling the raw ABI directly, and care should be taken not to reuse or alias handle values.

pub unsafe fn as_u32(&self) -> u32

Get the underlying representation of the handle.

This should only be used when calling the raw ABI directly, and care should be taken not to reuse or alias handle values.

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

Append another body onto the end of this body.

This operation is performed in amortized constant time, and so should always be preferred to reading an entire body and then writing the same contents to another body.

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

Examples

let mut streaming_body = response_handle.stream_to_client(BodyHandle::new());
streaming_body.append(other_body);

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

Write a slice of bytes to the end of this streaming body, and return the number of bytes written.

Examples

let mut streaming_body = response_handle.stream_to_client(BodyHandle::new());
streaming_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 streaming body, and return the number of bytes written.

Examples

let mut streaming_body = response_handle.stream_to_client(BodyHandle::new());
streaming_body.write_str("woof woof");

Trait Implementations

impl Debug for StreamingBodyHandle

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

Formats the value using the given formatter.

impl From<StreamingBodyHandle> for StreamingBody

fn from(handle: StreamingBodyHandle) -> Self

Converts to this type from the input type.

impl Hash for StreamingBodyHandle

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<StreamingBodyHandle> for StreamingBodyHandle

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

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

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

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

impl Write for StreamingBodyHandle

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 Writer 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” adapter for this instance of Write.

impl Eq for StreamingBodyHandle

impl StructuralEq for StreamingBodyHandle

impl StructuralPartialEq for StreamingBodyHandle