Struct exile::Pi

pub struct Pi { /* fields omitted */ }

Represents a Processing Instruction (PI) in an XML document.

XML Spec

https://www.w3.org/TR/2006/REC-xml11-20060816/#sec-pi [Definition: Processing instructions (PIs) allow documents to contain instructions for applications.]

Processing Instructions

[16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>' [17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))

PIs are not part of the document’s character data, but must be passed through to the application. The PI begins with a target (PITarget) used to identify the application to which the instruction is directed. The target names “XML”, “xml”, and so on are reserved for standardization in this or future versions of this specification. The XML Notation mechanism may be used for formal declaration of PI targets. Parameter entity references must not be recognized within processing instructions.

Implementations

impl Pi

pub fn new<S1, S2>(target: S1, data: S2) -> Result<Self, XDocErr> where
    S1: Into<String> + AsRef<str>,
    S2: Into<String> + AsRef<str>, 

Create a new processing instruction.

pub fn target(&self) -> &String

Return the target from a processing instruction, e.g. in <?foo bar baz?>, foo is the target.

pub fn data(&self) -> &String

Return the data from a processing instruction, e.g. in <?foo bar baz?>, bar baz is the data.

pub fn write<W>(
    &self,
    writer: &mut W,
    opts: &WriteOpts,
    depth: usize
) -> Result<(), XDocErr> where
    W: Write, 

Write the processing instruction to the Write object.

Trait Implementations

impl Clone for Pi

fn clone(&self) -> Pi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pi

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

Formats the value using the given formatter.

impl Default for Pi

fn default() -> Pi

Returns the “default value” for a type.

impl Display for Pi

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

Formats the value using the given formatter.

impl Hash for Pi

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Pi

fn cmp(&self, other: &Pi) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Pi> for Pi

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Pi> for Pi

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Eq for Pi

impl StructuralEq for Pi

impl StructuralPartialEq for Pi