Struct Cmap

pub struct Cmap<'a> { /* private fields */ }

Writer for a character map stream.

This struct is created by Chunk::cmap.

Implementations

impl<'a> Cmap<'a>

pub fn name(&mut self, name: Name<'_>) -> &mut Self

Write the /CMapName attribute. Required.

pub fn system_info(&mut self, info: SystemInfo<'_>) -> &mut Self

Write the /CIDSystemInfo attribute. Required.

pub fn writing_mode(&mut self, mode: WMode) -> &mut Self

Write the /WMode attribute. Optional.

This describes whether the CMap applies to a font with horizontal or vertical writing mode. The default is whatever is specified in the CMap.

This is required in PDF/A and must match the writing mode of the embedded CMap.

pub fn use_cmap_stream(&mut self, cmap: Ref) -> &mut Self

Write the /UseCMap attribute using a stream reference. Optional.

This allows specifying a base CMap to extend.

Note that this attribute is restricted in PDF/A and may only be used with the well-known CMap names from the PDF standard. Use Self::use_cmap_predefined to specify a predefined name.

pub fn use_cmap_predefined(&mut self, name: Name<'_>) -> &mut Self

Write the /UseCMap attribute using a predefined name. Optional.

This allows specifying a base CMap to extend.

Note that this attribute is restricted in PDF/A.

Methods from Deref<Target = Stream<'a>>

pub fn filter(&mut self, filter: Filter) -> &mut Self

Write the /Filter attribute.

pub fn decode_parms(&mut self) -> DecodeParms<'_>

Start writing the /DecodeParms attribute.

This is a dictionary that specifies parameters to be used in decoding the stream data using the filter specified by the /Filter attribute.

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

pub fn len(&self) -> i32

The number of written pairs.

pub fn is_empty(&self) -> bool

Whether no pairs have been written so far.

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

Start writing a pair with an arbitrary value.

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).

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

impl<'a> Deref for Cmap<'a>

type Target = Stream<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for Cmap<'a>

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

Mutably dereferences the value.