Struct Boundary 

pub struct Boundary(/* private fields */);

A multipart boundary, as RFC 2046 section 5.1.1 defines it: 1 to 70 characters from a restricted set, not ending in a space.

use base_web_multipart::Boundary;
use base_web_media_type::MediaType;

let media_type = MediaType::parse("multipart/form-data; boundary=\"simple boundary\"")?;
let boundary = Boundary::from_media_type(&media_type)?;
assert_eq!(boundary.as_str(), "simple boundary");

let generated = Boundary::generate();
assert_eq!(generated.as_str().len(), 32);
assert_eq!(generated.form_data_media_type().parameter("boundary"), Some(generated.as_str()));

Implementations

impl Boundary

pub const LENGTH_LIMIT: usize = 70

The longest boundary RFC 2046 allows.

pub fn new(text: &str) -> Result<Self, BoundaryError>

A boundary from text.

Errors

BoundaryError::Invalid when the text is not a boundary RFC 2046 allows.

pub fn from_media_type(media_type: &MediaType) -> Result<Self, BoundaryError>

The boundary of a multipart media type, from its boundary parameter.

Errors

BoundaryError::NotMultipart for another type, BoundaryError::Missing when there is no boundary parameter, and BoundaryError::Invalid when it is not a valid boundary.

pub fn generate() -> Self

A new boundary of 192 random bits from the operating system, written as 32 URL-safe base64 characters, so that content cannot contain it by chance or by an attacker’s design.

Panics

When the operating system’s random number generator fails, which it does not on supported platforms; the standard library’s hash maps rely on it in the same way.

pub fn as_str(&self) -> &str

The boundary as text.

pub fn to_media_type(&self, subtype: &str) -> Result<MediaType, MediaTypeError>

The media type multipart/{subtype} with this boundary as its parameter, such as multipart/mixed; boundary=....

Errors

When the subtype is not a token, or is a wildcard.

pub fn form_data_media_type(&self) -> MediaType

The media type multipart/form-data with this boundary as its parameter.

Trait Implementations

impl AsRef<str> for Boundary

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Boundary

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Boundary

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

Formats the value using the given formatter.

impl Display for Boundary

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

Formats the value using the given formatter.

impl Eq for Boundary

impl FromStr for Boundary

type Err = BoundaryError

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Boundary

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 PartialEq for Boundary

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Boundary