Struct CommentBody 

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

What a comment says: anything at all, except nothing.

A newtype rather than a String checked by whoever happens to read it, because an empty comment is refused by every source this product drives and by the command line before any of them: a value of this type is one a source can be handed without asking again. Everything else about the text is kept exactly — no trimming, no newline normalisation — because a body quoting a command or a stack trace is only useful byte for byte.

Implementations

impl CommentBody

pub fn new(text: impl Into<String>) -> Result<Self, SourceError>

Wrap text as a comment body.

Errors

Returns SourceError::Refused when text is empty, saying so.

pub fn as_str(&self) -> &str

The text, exactly as it was given.

Trait Implementations

impl Clone for CommentBody

fn clone(&self) -> CommentBody

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommentBody

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommentBody

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommentBody

impl From<CommentBody> for String

fn from(body: CommentBody) -> Self

Converts to this type from the input type.

impl JsonSchema for CommentBody

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for CommentBody

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CommentBody

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommentBody

impl TryFrom<String> for CommentBody

type Error = String

The type returned in the event of a conversion error.

fn try_from(text: String) -> Result<Self, Self::Error>

Performs the conversion.