Struct soup::MultipartInputStream

pub struct MultipartInputStream { /* private fields */ }

Handles streams of multipart messages.

This adds support for the multipart responses. For handling the multiple parts the user needs to wrap the gio::InputStream obtained by sending the request with a MultipartInputStream and use next_part() before reading. Responses which are not wrapped will be treated like non-multipart responses.

Note that although #SoupMultipartInputStream is a gio::InputStream, you should not read directly from it, and the results are undefined if you do.

Properties

message

The Message.

Readable | Writeable | Construct Only

FilterInputStream

base-stream

The underlying base stream on which the I/O ops will be done.

Readable | Writeable | Construct Only

close-base-stream

Whether the base stream should be closed when the filter stream is closed.

Readable | Writeable | Construct

Implements

gio::prelude::FilterInputStreamExt, gio::prelude::InputStreamExt, [trait@glib::ObjectExt], gio::prelude::PollableInputStreamExt

Implementations

impl MultipartInputStream

pub fn new( msg: &Message, base_stream: &impl IsA<InputStream> ) -> MultipartInputStream

Creates a new #SoupMultipartInputStream that wraps the gio::InputStream obtained by sending the Message.

Reads should not be done directly through this object, use the input streams returned by next_part() or its async counterpart instead.

msg

the #SoupMessage the response is related to.

base_stream

the #GInputStream returned by sending the request.

Returns

a new #SoupMultipartInputStream

pub fn builder() -> MultipartInputStreamBuilder

Creates a new builder-pattern struct instance to construct MultipartInputStream objects.

This method returns an instance of MultipartInputStreamBuilder which can be used to create MultipartInputStream objects.

pub fn headers(&self) -> Option<MessageHeaders>

Obtains the headers for the part currently being processed.

Note that the MessageHeaders that are returned are owned by the #SoupMultipartInputStream and will be replaced when a call is made to next_part() or its async counterpart, so if keeping the headers is required, a copy must be made.

Note that if a part had no headers at all an empty MessageHeaders will be returned.

Returns

a #SoupMessageHeaders containing the headers for the part currently being processed or None if the headers failed to parse.

pub fn next_part( &self, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<Option<InputStream>, Error>

Obtains an input stream for the next part.

When dealing with a multipart response the input stream needs to be wrapped in a #SoupMultipartInputStream and this function or its async counterpart need to be called to obtain the first part for reading.

After calling this function, headers() can be used to obtain the headers for the first part. A read of 0 bytes indicates the end of the part; a new call to this function should be done at that point, to obtain the next part.

cancellable

a #GCancellable

Returns

a new #GInputStream, or None if there are no more parts

pub fn message(&self) -> Option<Message>

The Message.

Trait Implementations

impl Clone for MultipartInputStream

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MultipartInputStream

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

Formats the value using the given formatter.

impl Default for MultipartInputStream

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for MultipartInputStream

type ParamSpec = ParamSpecObject

type SetValue = MultipartInputStream

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, MultipartInputStream>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MultipartInputStream

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MultipartInputStream

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for MultipartInputStream

type Parent = FilterInputStream

impl<OT: ObjectType> PartialEq<OT> for MultipartInputStream

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

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

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<OT: ObjectType> PartialOrd<OT> for MultipartInputStream

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for MultipartInputStream

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MultipartInputStream

impl IsA<FilterInputStream> for MultipartInputStream

impl IsA<InputStream> for MultipartInputStream

impl IsA<PollableInputStream> for MultipartInputStream