Namespace

Struct Namespace 

Source
pub struct Namespace<'a> { /* private fields */ }
Expand description

Writer for a namespace dictionary. PDF 2.0+

This struct is created by Chunk::namespace.

Implementations§

Source§

impl Namespace<'_>

Source

pub fn ns(&mut self, identifier: TextStr<'_>) -> &mut Self

Write the /NS attribute to specify the identifier (URI) of the namespace.

Source

pub fn schema(&mut self) -> FileSpec<'_>

Start writing the /Schema attribute to point to a schema definition for the namespace. Optional.

Source

pub fn role_map_ns(&mut self) -> NamespaceRoleMap<'_>

Start writing the /RoleMapNS attribute to map structure elements to elements in another namespace. Optional.

For a mechanism to define role mappings compatible with PDF 1.3 and above, see StructTreeRoot::role_map.

Source

pub fn pdf_2_ns(self)

Write the namespace dictionary for the standard structure namespace for PDF 2.0.

Source

pub fn pdf_1_7_ns(self)

Write the namespace dictionary for the standard structure namespace for PDF 1.7.

Source

pub fn mathml_3_0_ns(self)

Write the namespace dictionary for MathML 3.0.

Methods from Deref<Target = Dict<'a>>§

Source

pub fn len(&self) -> i32

The number of written pairs.

Source

pub fn is_empty(&self) -> bool

Whether no pairs have been written so far.

Source

pub fn insert(&mut self, key: Name<'_>) -> Obj<'_>

Start writing a pair with an arbitrary value.

Source

pub fn pair<T: Primitive>(&mut self, key: Name<'_>, value: T) -> &mut Self

Write a pair with a primitive value.

This is a shorthand for dict.insert(key).primitive(value).

Source

pub fn pairs<'n, T: Primitive>( &mut self, pairs: impl IntoIterator<Item = (Name<'n>, T)>, ) -> &mut Self

Write a sequence of pairs with primitive values.

Trait Implementations§

Source§

impl<'a> Deref for Namespace<'a>

Source§

type Target = Dict<'a>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<'a> DerefMut for Namespace<'a>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<'a, 'any> Rewrite<'a> for Namespace<'any>

Source§

type Output = Namespace<'a>

The writer with the rewritten lifetime.
Source§

impl<'a> Writer<'a> for Namespace<'a>

Source§

fn start(obj: Obj<'a>) -> Self

Start writing the object.

Auto Trait Implementations§

§

impl<'a> Freeze for Namespace<'a>

§

impl<'a> RefUnwindSafe for Namespace<'a>

§

impl<'a> Send for Namespace<'a>

§

impl<'a> Sync for Namespace<'a>

§

impl<'a> Unpin for Namespace<'a>

§

impl<'a> !UnwindSafe for Namespace<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Finish for T

Source§

fn finish(self)

Does nothing but move self, equivalent to drop.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.