Struct pdf_writer::writers::ImageXObject

pub struct ImageXObject<'a> { /* fields omitted */ }

Writer for an image XObject stream.

This struct is created by PdfWriter::image_xobject.

Implementations

impl<'a> ImageXObject<'a>

pub fn width(&mut self, width: i32) -> &mut Self

Write the /Width attribute.

pub fn height(&mut self, height: i32) -> &mut Self

Write the /Height attribute.

pub fn color_space(&mut self) -> ColorSpace<'_>

Write the /ColorSpace attribute.

Required for all images except if using the JPXDecode filter. If this is an image soft mask, the color space must be DeviceGray. Must not be Pattern.

pub fn bits_per_component(&mut self, bits: i32) -> &mut Self

Write the /BitsPerComponent attribute. Required.

Required for all images except if using the JPXDecode filter.

pub fn intent(&mut self, intent: RenderingIntent) -> &mut Self

Write the /Intent attribute. PDF 1.1+.

pub fn interpolate(&mut self, interpolate: bool) -> &mut Self

Write the /Interpolate attribute.

pub fn alternates(
    &mut self,
    alternates: impl IntoIterator<Item = Ref>
) -> &mut Self

Write the /Alternates attribute. PDF 1.3+.

Images that may replace this image. The order is not relevant.

pub fn s_mask(&mut self, x_object: Ref) -> &mut Self

Start writing the /SMask attribute. PDF 1.4+.

Must not be used if this image already is an image soft mask.

pub fn s_mask_in_data(&mut self, mode: SMaskInData) -> &mut Self

Write the /SMaskInData attribute. PDF 1.5+.

May only be used for images that use the JPXDecode filter. If set to something other than Ignore, the SMask attribute must not be used.

pub fn matte(&mut self, color: impl IntoIterator<Item = f32>) -> &mut Self

Write the /Matte attribute for image soft masks. PDF 1.4+.

This shall be the matte color of the parent image encoded in its color space.

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

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

Write the /Filter attribute.

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

pub fn len(&self) -> i32

The number of written pairs.

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 ImageXObject<'a>

type Target = Stream<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> DerefMut for ImageXObject<'a>

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

Mutably dereferences the value.