Struct Content 

pub struct Content<'a> { /* private fields */ }

Text, or a JSON object or array.

The lifetime is the input the value borrows from: Content<'static> owns everything it holds, which is what a decoded response produces, while a request can be built from a &str the caller already has without copying it.

Text is written out as a JSON string by any serializer. A JSON object or array is spliced in byte for byte by the SDK and written out as data by every other serializer, which is described on RawJson.

Reading a Content back always takes the value as JSON text. A JSON codec (sonic-rs, serde_json) hands over that text, so any Content round-trips through one; a non-JSON serde format hands over a text value as a bare string, which is then parsed as JSON, so plain text such as low fails to read back there.

use typesafe_sdk::Content;

let borrowed = Content::text("payments or invoices");
assert_eq!(borrowed.as_text(), Some("payments or invoices"));

let structured = Content::json(&[1, 2, 3])?;
assert_eq!(structured.as_json().map(|raw| raw.as_str()), Some("[1,2,3]"));

Implementations

impl<'a> Content<'a>

pub fn text(text: impl Into<Cow<'a, str>>) -> Self

Wraps text, borrowing it when the caller owns it elsewhere.

A caller who wants the JSON shape of a value calls Content::json.

pub fn json<T>(value: &T) -> Result<Self, ContentError>

where T: Serialize + ?Sized,

Encodes value and keeps the result.

A value that encodes to a JSON string becomes text, so Content::json(&"hello") and Content::text("hello") are equal.

Errors

Returns ContentError::Shape when the value encodes to a number, a boolean or null, and ContentError::Encode when it cannot be encoded at all.

pub fn as_text(&self) -> Option<&str>

The text, when this is a string.

pub fn as_json(&self) -> Option<&RawJson>

The raw JSON, when this is an object or an array.

pub fn into_owned(self) -> Content<'static>

Detaches the value from whatever it borrows, copying only if it has to.

Trait Implementations

impl<'a> Clone for Content<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Content<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for Content<'a>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Eq for Content<'a>

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

Builds the text shape, borrowing text; see Content::text.

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

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Content<'a>

Builds the text shape, borrowing or owning as text does; see Content::text.

fn from(text: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl From<String> for Content<'_>

Builds the text shape, owning text; see Content::text.

fn from(text: String) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Content<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Content<'_>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for Content<'a>