Struct ReleaseNotes 

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

Implementations

impl ReleaseNotes

pub const MAX_CHAR_LENGTH: usize = 10_000usize

pub fn new<T: AsRef<str>>(release_notes: T) -> Result<Self, ReleaseNotesError>

Creates a new ReleaseNotes from any type that implements AsRef<str>.

Release notes greater than 10,000 characters will be truncated to the first line where the total number of characters of that line and all previous lines are less than or equal to 10,000 characters.

Errors

Returns an Err if the release notes are empty.

pub unsafe fn new_unchecked<T: Into<String>>(release_notes: T) -> Self

Creates a new ReleaseNotes from any type that implements <Into<String>> without checking whether it is empty.

Safety

The value must not be empty.

pub const fn as_str(&self) -> &str

Trait Implementations

impl AsRef<str> for ReleaseNotes

fn as_ref(&self) -> &str

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

impl Clone for ReleaseNotes

fn clone(&self) -> ReleaseNotes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReleaseNotes

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

Formats the value using the given formatter.

impl Default for ReleaseNotes

fn default() -> ReleaseNotes

Returns the “default value” for a type.

impl Display for ReleaseNotes

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

Formats the value using the given formatter.

impl FromStr for ReleaseNotes

type Err = ReleaseNotesError

The associated error which can be returned from parsing.

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

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

impl Hash for ReleaseNotes

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 ReleaseNotes

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

Restrict a value to a certain interval.

impl PartialEq for ReleaseNotes

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ReleaseNotes

fn partial_cmp(&self, other: &ReleaseNotes) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<String> for ReleaseNotes

type Error = ReleaseNotesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for ReleaseNotes

impl StructuralPartialEq for ReleaseNotes