Struct soup::Multipart

pub struct Multipart { /* private fields */ }

Represents a multipart HTTP message body, parsed according to the syntax of RFC 2046.

Of particular interest to HTTP are multipart/byte-ranges and multipart/form-data,

Although the headers of a #SoupMultipart body part will contain the full headers from that body part, libsoup does not interpret them according to MIME rules. For example, each body part is assumed to have “binary” Content-Transfer-Encoding, even if its headers explicitly state otherwise. In other words, don’t try to use #SoupMultipart for handling real MIME multiparts.

Implementations

impl Multipart

pub fn as_ptr(&self) -> *mut SoupMultipart

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow<'a>( ptr: *const *const SoupMultipart ) -> &'a Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut<'a>( ptr: *mut *mut SoupMultipart ) -> &'a mut Self

Borrows the underlying C value mutably.

impl Multipart

pub fn new(mime_type: &str) -> Multipart

Creates a new empty #SoupMultipart with a randomly-generated boundary string.

Note that @mime_type must be the full MIME type, including “multipart/”.

See also: Message::from_multipart().

mime_type

the MIME type of the multipart to create.

Returns

a new empty #SoupMultipart of the given @mime_type

pub fn from_message(headers: &MessageHeaders, body: &Bytes) -> Option<Multipart>

Parses @headers and @body to form a new #SoupMultipart

headers

the headers of the HTTP message to parse

body

the body of the HTTP message to parse

Returns

a new #SoupMultipart (or None if the message couldn’t be parsed or wasn’t multipart).

pub fn append_form_file( &mut self, control_name: &str, filename: Option<&str>, content_type: Option<&str>, body: &Bytes )

Adds a new MIME part containing @body to @self

Uses “Content-Disposition: form-data”, as per the HTML forms specification.

control_name

the name of the control associated with this file

filename

the name of the file, or None if not known

content_type

the MIME type of the file, or None if not known

body

the file data

pub fn append_form_string(&mut self, control_name: &str, data: &str)

Adds a new MIME part containing @data to @self.

Uses “Content-Disposition: form-data”, as per the HTML forms specification.

control_name

the name of the control associated with @data

data

the body data

pub fn append_part(&mut self, headers: &MessageHeaders, body: &Bytes)

Adds a new MIME part to @self with the given headers and body.

(The multipart will make its own copies of @headers and @body, so you should free your copies if you are not using them for anything else.)

headers

the MIME part headers

body

the MIME part body

pub fn length(&mut self) -> i32

Gets the number of body parts in @self.

Returns

the number of body parts in @self

pub fn part(&mut self, part: i32) -> Option<(MessageHeaders, Bytes)>

Gets the indicated body part from @self.

part

the part number to get (counting from 0)

Returns

true on success, false if @part is out of range (in which case @headers and @body won’t be set)

headers

return location for the MIME part headers

body

return location for the MIME part body

pub fn to_message(&mut self, dest_headers: &MessageHeaders) -> Bytes

Serializes @self to @dest_headers and @dest_body.

dest_headers

the headers of the HTTP message to serialize @self to

Returns

dest_body

the body of the HTTP message to serialize @self to

Trait Implementations

impl Clone for Multipart

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 Multipart

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

Formats the value using the given formatter.

impl From<Multipart> for Value

fn from(o: Multipart) -> Self

Converts to this type from the input type.

impl HasParamSpec for Multipart

type ParamSpec = ParamSpecBoxed

type SetValue = Multipart

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

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, Multipart>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Multipart

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Multipart

fn cmp(&self, other: &Multipart) -> 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 PartialEq for Multipart

fn eq(&self, other: &Multipart) -> 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 PartialOrd for Multipart

fn partial_cmp(&self, other: &Multipart) -> 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 Multipart

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Multipart

impl StructuralPartialEq for Multipart