Enum pyproject_toml::ReadMe

pub enum ReadMe {
    RelativePath(String),
    Table {
        file: Option<String>,
        text: Option<String>,
        content_type: Option<String>,
    },
}

The full description of the project (i.e. the README).

Variants

RelativePath(String)

Relative path to a text file containing the full description

Table

Detailed readme information

Fields

file: Option<String>

A relative path to a file containing the full description

text: Option<String>

Full description

content_type: Option<String>

The content-type of the full description

Trait Implementations

impl Clone for ReadMe

fn clone(&self) -> ReadMe

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReadMe

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReadMe

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReadMe

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

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 ReadMe

impl StructuralPartialEq for ReadMe