Struct Text 

pub struct Text {
    pub content: String,
}

Text document with unconstrained content

Fields

content: String

Raw text content

Trait Implementations

impl Analysis for Text

fn standard() -> Standard

Returns the metadata standard represented by the implementing type.

fn check_prose<'life0, 'life1, 'async_trait>( paths: &'life0 [PathBuf], options: Option<&'life1 CheckOptions>, ) -> Pin<Box<dyn Future<Output = Vec<Check>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait,

Perform analysis of prose

fn check_quality<'life0, 'life1, 'async_trait>( paths: &'life0 [PathBuf], _options: Option<&'life1 CheckOptions>, ) -> Pin<Box<dyn Future<Output = Vec<Check>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait,

Perform quality checks and verify data consistency

fn check_readability<'life0, 'life1, 'async_trait>( paths: &'life0 [PathBuf], options: Option<&'life1 CheckOptions>, ) -> Pin<Box<dyn Future<Output = Vec<Check>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait,

Calculate readability using a given metric

fn output_path(path: &Path, _data: &Self) -> PathBuf

Returns the output path used for Vale analysis artifacts.

fn check<'life0, 'life1, 'async_trait>( category: CheckCategory, paths: &'life0 [PathBuf], options: Option<&'life1 CheckOptions>, ) -> Pin<Box<dyn Future<Output = Vec<Check>> + Send + 'async_trait>>

where Self: Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Run analysis for a given category

fn check_schema<'life0, 'life1, 'async_trait>( _paths: &'life0 [PathBuf], _options: Option<&'life1 CheckOptions>, ) -> Pin<Box<dyn Future<Output = Vec<Check>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait,

Execute validation checks for a given item

fn check_websites<'life0, 'life1, 'async_trait>( _paths: &'life0 [PathBuf], _options: Option<&'life1 CheckOptions>, ) -> Pin<Box<dyn Future<Output = Vec<Check>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait,

Check if URLs links are valid and readable

fn flatten_checks<'async_trait, I, F>( futures: I, ) -> Pin<Box<dyn Future<Output = Vec<Check>> + Send + 'async_trait>>

where I: IntoIterator<Item = F> + Send + 'async_trait, F: Future<Output = Vec<Check>> + Send + 'async_trait,

Flatten a collection of futures that each return a vector of checks into a single vector

fn collect_checks<'a, 'life0, 'async_trait>( futures: impl 'async_trait + IntoIterator<Item = BoxFuture<'a, Check>> + Send, path: &'life0 Path, ) -> Pin<Box<dyn Future<Output = Vec<Check>> + Send + 'async_trait>>

where 'a: 'async_trait, 'life0: 'async_trait,

Collect link checks from futures and attach URI to each check

impl Clone for Text

fn clone(&self) -> Text

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Text

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Text

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for Text

fn from(content: &str) -> Self

Converts to this type from the input type.

impl From<String> for Text

fn from(content: String) -> Self

Converts to this type from the input type.

impl InputOutput for Text

Available on crate feature std only.

fn read(path: impl Into<PathBuf>) -> ApiResult<Self>

Read data from specified file path

fn read_json(path: PathBuf) -> ApiResult<Self>

Read data from specified JSON file path

fn read_markdown(path: PathBuf) -> ApiResult<Self>

Read data as Markdown from specified path

fn read_yaml(path: PathBuf) -> ApiResult<Self>

Read data from specified YAML file path

fn write(&self, path: impl Into<PathBuf>) -> ApiResult<()>

Write data to specified path

fn write_json(&self, path: impl Into<PathBuf>) -> ApiResult<()>

Write data as JSON to specified path

fn write_markdown(&self, path: impl Into<PathBuf>) -> ApiResult<()>

Write data as Markdown (MD) to specified path

fn write_yaml(&self, path: impl Into<PathBuf>) -> ApiResult<()>

Write data as YAML to specified path

fn read_cff(_path: impl Into<PathBuf>) -> ApiResult<Self>

Read data as CFF from specified path

fn read_jsonc(_path: PathBuf) -> ApiResult<Self>

Read data from specified JSONC file path

fn write_cff(&self, _path: impl Into<PathBuf>) -> ApiResult<()>

Write data as CFF to specified path

impl JsonSchema for Text

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 MarkdownSupport for Text

fn to_markdown(&self) -> String

Convert self to Markdown format string

fn from_markdown(content: &str) -> Result<Self, String>

where Self: Sized,

Parse Markdown content into a value.

fn from_front_matter(value: &str) -> Result<Self, String>

where Self: DeserializeOwned + Sized,

Deserialize YAML front matter while preserving nested enum representations.

fn to_front_matter(&self) -> Result<String, String>

where Self: Serialize,

Serialize YAML front matter while preserving nested enum representations.

impl PartialEq for Text

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Text

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 Text

impl ToProse for Text

fn to_prose(&self) -> String

Convert self to prose format string

impl TryFrom<&Path> for Text

Available on crate feature std only.

type Error = Report

The type returned in the event of a conversion error.

fn try_from(path: &Path) -> Result<Self, Self::Error>

Performs the conversion.

impl Unstructured for Text

fn content(&self) -> &str

Return raw content as a string slice

impl Validate for Text

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for Text

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>