Struct PdfSurface

Source

pub struct PdfSurface(/* private fields */);

Available on crate feature pdf only.

Implementations§

Source §

impl PdfSurface

Source

pub fn new<P: AsRef<Path>>( width: f64, height: f64, path: P, ) -> Result<Self, Error>

Source

pub fn for_stream<W: Write + 'static>( width: f64, height: f64, stream: W, ) -> Result<Self, Error>

Takes full ownership of the output stream, which is not allowed to borrow any lifetime shorter than 'static.

Because the underlying cairo_surface_t is reference-counted, a lifetime parameter in a Rust wrapper type would not be enough to track how long it can keep writing to the stream.

Source

pub unsafe fn for_raw_stream<W: Write + 'static>( width: f64, height: f64, stream: *mut W, ) -> Result<Self, Error>

Allows writing to a borrowed stream. The lifetime of the borrow is not tracked.

§Safety

The value that stream points to must live at least until the underlying cairo_surface_t (which maybe be longer then the Rust PdfSurface wrapper, because of reference-counting), or until the output stream is removed from the surface with Surface::finish_output_stream.

Since the former is hard to track for sure, the latter is strongly recommended. The concrete type behind the Box<dyn Any> value returned by finish_output_stream is private, so you won’t be able to downcast it. But removing it anyway ensures that later writes do not go through a dangling pointer.

Source

pub fn set_metadata( &self, metadata: PdfMetadata, value: &str, ) -> Result<(), Error>

Available on crate feature v1_16 only.

Source

pub fn set_custom_metadata(&self, name: &str, value: &str) -> Result<(), Error>

Available on crate feature v1_18 only.

Source

pub fn set_page_label(&self, label: &str) -> Result<(), Error>

Available on crate feature v1_16 only.

Source

pub fn set_thumbnail_size(&self, width: i32, height: i32) -> Result<(), Error>

Available on crate feature v1_16 only.

Source

pub fn add_outline( &self, parent_id: i32, name: &str, link_attribs: &str, flags: PdfOutline, ) -> Result<i32, Error>

Available on crate feature v1_16 only.

Methods from Deref<Target = Surface>§

Source

pub fn to_raw_none(&self) -> *mut cairo_surface_t

Source

pub fn create_similar( &self, content: Content, width: i32, height: i32, ) -> Result<Surface, Error>

Source

pub fn create_for_rectangle(&self, bounds: Rectangle) -> Result<Surface, Error>

Source

pub fn mime_data(&self, mime_type: &str) -> Option<Vec<u8>>

Source

pub unsafe fn mime_data_raw(&self, mime_type: &str) -> Option<&[u8]>

Source

pub fn set_mime_data<T: AsRef<[u8]> + 'static>( &self, mime_type: &str, slice: T, ) -> Result<(), Error>

Source

pub fn supports_mime_type(&self, mime_type: &str) -> bool

Source

pub fn device(&self) -> Option<Device>

Source

pub fn content(&self) -> Content

Source

pub fn set_device_offset(&self, x_offset: f64, y_offset: f64)

Source

pub fn device_offset(&self) -> (f64, f64)

Source

pub fn set_device_scale(&self, x_scale: f64, y_scale: f64)

Source

pub fn device_scale(&self) -> (f64, f64)

Source

pub fn set_fallback_resolution( &self, x_pixels_per_inch: f64, y_pixels_per_inch: f64, )

Source

pub fn fallback_resolution(&self) -> (f64, f64)

Source

pub fn create_similar_image( &self, format: Format, width: i32, height: i32, ) -> Result<ImageSurface, Error>

Source

pub fn map_to_image( &self, extents: Option<RectangleInt>, ) -> Result<MappedImageSurface, Error>

Source

pub fn mark_dirty(&self)

Source

pub fn mark_dirty_rectangle(&self, x: i32, y: i32, width: i32, height: i32)

Source

pub fn status(&self) -> Result<(), Error>

Source

pub fn set_user_data<T: 'static>( &self, key: &'static UserDataKey<T>, value: Rc<T>, ) -> Result<(), Error>

Attach user data to self for the given key.

Source

pub fn user_data<T: 'static>( &self, key: &'static UserDataKey<T>, ) -> Option<Rc<T>>

Return the user data previously attached to self with the given key, if any.

Source

pub fn user_data_ptr<T: 'static>( &self, key: &'static UserDataKey<T>, ) -> Option<NonNull<T>>

Return the user data previously attached to self with the given key, if any, without incrementing the reference count.

The pointer is valid when it is returned from this method, until the cairo object that self represents is destroyed or remove_user_data or set_user_data is called with the same key.

Source