Struct Payload

pub struct Payload<T> { /* private fields */ }

The payload for object uploads via the Storage client.

The storage client functions to upload new objects consume any type that can be converted to this type. That includes simple buffers, and any type implementing StreamingSource.

Example

use google_cloud_storage::upload_source::StreamingSource;
let buffer : &[u8] = b"the quick brown fox jumps over the lazy dog";
let mut size = 0_usize;
let mut payload = Payload::from(bytes::Bytes::from_static(buffer));
while let Some(bytes) = payload.next().await.transpose()? {
    size += bytes.len();
}
assert_eq!(size, buffer.len());

Implementations

impl<T> Payload<T>

where T: StreamingSource,

pub fn from_stream(payload: T) -> Self

Trait Implementations

impl From<&'static str> for Payload<BytesSource>

fn from(value: &'static str) -> Self

Converts to this type from the input type.

impl From<Bytes> for Payload<BytesSource>

fn from(value: Bytes) -> Self

Converts to this type from the input type.

impl From<File> for Payload<FileSource>

fn from(value: File) -> Self

Converts to this type from the input type.

impl<S> From<S> for Payload<S>

where S: StreamingSource,

fn from(value: S) -> Self

Converts to this type from the input type.

impl From<Vec<Bytes>> for Payload<IterSource>

fn from(value: Vec<Bytes>) -> Self

Converts to this type from the input type.

impl<T> Seek for Payload<T>

where T: Seek,

type Error = <T as Seek>::Error

The error type.

fn seek( &mut self, offset: u64, ) -> impl Future<Output = Result<(), Self::Error>> + Send

Resets the stream to start from offset.

impl<T> StreamingSource for Payload<T>

where T: StreamingSource + Send + Sync,

type Error = <T as StreamingSource>::Error

The error type.

async fn next(&mut self) -> Option<Result<Bytes, Self::Error>>

Gets the next set of data to upload.

async fn size_hint(&self) -> Result<(u64, Option<u64>), Self::Error>

An estimate of the upload size.