Enum pact_models::bodies::OptionalBody

pub enum OptionalBody {
    Missing,
    Empty,
    Null,
    Present(Bytes, Option<ContentType>, Option<ContentTypeHint>),
}

Enum that defines the four main states that a body of a request and response can be in a pact file.

Variants

Missing

A body is missing if it is not present in the pact file

Empty

An empty body that is present in the pact file.

Null

A JSON body that is the null value. This state is to protect other language implementations from null values. It is treated as Empty.

Present(Bytes, Option<ContentType>, Option<ContentTypeHint>)

A non-empty body that is present in the pact file.

Implementations

impl OptionalBody

pub fn is_present(&self) -> bool

If the body is present in the pact file and not empty or null.

pub fn value(&self) -> Option<Bytes>

Returns the body if present, otherwise returns None.

pub fn value_as_string(&self) -> Option<String>

Returns the body as a UTF-8 string if present and is a textual form, otherwise returns None.

pub fn str_value(&self) -> &str

👎Deprecated since 0.4.2: This does not deal with binary bodies, use value_as_str or display_string instead

Returns the body if present as a UTF-8 string, otherwise returns the empty string.

pub fn display_string(&self) -> String

For text bodies (are present and have either a content type hint of TEXT or a content type that is a known textual form), returns the body as a UTF-8 string. Otherwise, if the body is present, will display the first 32 bytes in hexidecimal form. Otherwise returns the empty string.

pub fn has_content_type(&self) -> bool

If the body has a content type associated to it

pub fn content_type(&self) -> Option<ContentType>

Parsed content type of the body

pub fn with_content_type(&self, content_type: Option<ContentType>) -> Self

Clones this body, setting the content type

pub fn with_content_type_if_not_set( &self, content_type: Option<ContentType> ) -> Self

Clones this body, setting the content type if it is not set

pub fn to_v4_json(&self) -> Value

Converts this body into a V4 Pact file JSON format

pub fn set_content_type(&mut self, content_type: &ContentType)

Set the content type of the body. If the body is missing or empty, this is a no-op.

Trait Implementations

impl Clone for OptionalBody

fn clone(&self) -> OptionalBody

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptionalBody

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

Formats the value using the given formatter.

impl Default for OptionalBody

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OptionalBody

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OptionalBody

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

Formats the value using the given formatter.

impl From<&Value> for OptionalBody

fn from(json: &Value) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for OptionalBody

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl From<String> for OptionalBody

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Value> for OptionalBody

fn from(json: Value) -> Self

Converts to this type from the input type.

impl Hash for OptionalBody

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 OptionalBody

fn eq(&self, other: &Self) -> 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 Serialize for OptionalBody

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OptionalBody