Struct IncludeContent 

pub struct IncludeContent { /* private fields */ }

The content returned by an IncludeFileHandler for an include:: directive, together with the metadata the parser needs to finish processing the include.

Construct one via IncludeContent::new for UTF-8 content that was read without interpreting the encoding attribute, or via IncludeContent::transcoded for content the handler transcoded to UTF-8 while honoring a requested encoding. See the # Encoding section of IncludeFileHandler::resolve_target for details.

Implementations

impl IncludeContent

pub fn new(content: impl Into<String>) -> Self

UTF-8 content that was read without interpreting the encoding attribute.

If the include:: directive requested a non-UTF-8 encoding, the parser will emit a non-UTF-8 include-encoding warning. This is the appropriate constructor for a handler that only deals in UTF-8.

pub fn transcoded(content: impl Into<String>) -> Self

Content that the handler transcoded to UTF-8 while honoring the requested encoding attribute.

The parser will not emit a non-UTF-8 include-encoding warning for content returned this way, since the handler has already reencoded it.

pub fn content(&self) -> &str

Returns the UTF-8 content of the include.

pub fn encoding_handled(&self) -> bool

Returns true if the handler honored the requested encoding attribute (i.e. the content was created via IncludeContent::transcoded).

pub fn into_content(self) -> String

Consumes the IncludeContent, returning the owned UTF-8 content.

Trait Implementations

impl Clone for IncludeContent

fn clone(&self) -> IncludeContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncludeContent

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

Formats the value using the given formatter.

impl Eq for IncludeContent

impl From<&str> for IncludeContent

fn from(content: &str) -> Self

Converts to this type from the input type.

impl From<String> for IncludeContent

fn from(content: String) -> Self

Converts to this type from the input type.

impl PartialEq for IncludeContent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IncludeContent