#[repr(transparent)]pub struct PsSurface(_);
Implementations§
source§impl PsSurface
impl PsSurface
pub fn new<P: AsRef<Path>>( width: f64, height: f64, path: P ) -> Result<PsSurface, Error>
sourcepub fn for_stream<W: Write + 'static>(
width: f64,
height: f64,
stream: W
) -> Result<Self, Error>
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.
sourcepub unsafe fn for_raw_stream<W: Write + 'static>(
width: f64,
height: f64,
stream: *mut W
) -> Result<Self, Error>
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.
pub fn levels() -> impl Iterator<Item = PsLevel>
pub fn restrict(&self, level: PsLevel)
pub fn is_eps(&self) -> bool
pub fn set_eps(&self, eps: bool)
pub fn set_size(&self, width: f64, height: f64)
pub fn dsc_begin_setup(&self)
pub fn begin_page_setup(&self)
pub fn dsc_comment(&self, comment: &str)
Methods from Deref<Target = Surface>§
pub fn to_raw_none(&self) -> *mut cairo_surface_t
pub fn create_similar( &self, content: Content, width: i32, height: i32 ) -> Result<Surface, Error>
pub fn create_for_rectangle(&self, bounds: Rectangle) -> Result<Surface, Error>
pub fn mime_data(&self, mime_type: &str) -> Option<Vec<u8>>
pub unsafe fn mime_data_raw(&self, mime_type: &str) -> Option<&[u8]>
pub fn set_mime_data<T: AsRef<[u8]> + 'static>( &self, mime_type: &str, slice: T ) -> Result<(), Error>
pub fn supports_mime_type(&self, mime_type: &str) -> bool
pub fn device(&self) -> Option<Device>
pub fn content(&self) -> Content
pub fn set_device_offset(&self, x_offset: f64, y_offset: f64)
pub fn device_offset(&self) -> (f64, f64)
pub fn set_device_scale(&self, x_scale: f64, y_scale: f64)
pub fn device_scale(&self) -> (f64, f64)
pub fn set_fallback_resolution( &self, x_pixels_per_inch: f64, y_pixels_per_inch: f64 )
pub fn fallback_resolution(&self) -> (f64, f64)
pub fn create_similar_image( &self, format: Format, width: i32, height: i32 ) -> Result<Surface, Error>
pub fn map_to_image( &self, extents: Option<RectangleInt> ) -> Result<MappedImageSurface, Error>
pub fn mark_dirty(&self)
pub fn mark_dirty_rectangle(&self, x: i32, y: i32, width: i32, height: i32)
pub fn status(&self) -> Result<(), Error>
sourcepub fn set_user_data<T: 'static>(
&self,
key: &'static UserDataKey<T>,
value: Rc<T>
) -> Result<(), Error>
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
.
sourcepub fn user_data<T: 'static>(
&self,
key: &'static UserDataKey<T>
) -> Option<Rc<T>>
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.
sourcepub fn user_data_ptr<T: 'static>(
&self,
key: &'static UserDataKey<T>
) -> Option<NonNull<T>>
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.
sourcepub fn remove_user_data<T: 'static>(
&self,
key: &'static UserDataKey<T>
) -> Result<(), Error>
pub fn remove_user_data<T: 'static>( &self, key: &'static UserDataKey<T> ) -> Result<(), Error>
Unattached from self
the user data associated with key
, if any.
If there is no other Rc
strong reference, the data is destroyed.
pub fn flush(&self)
pub fn finish(&self)
pub fn type_(&self) -> SurfaceType
sourcepub fn write_to_png<W: Write>(&self, stream: &mut W) -> Result<(), IoError>
pub fn write_to_png<W: Write>(&self, stream: &mut W) -> Result<(), IoError>
This function writes the surface as a PNG image to the given stream.
If the underlying surface does not support being written as a PNG, this will return
Error::SurfaceTypeMismatch
sourcepub fn finish_output_stream(&self) -> Result<Box<dyn Any>, StreamWithError>
pub fn finish_output_stream(&self) -> Result<Box<dyn Any>, StreamWithError>
Finish the surface, then remove and return the output stream if any.
This calls Surface::finish
, to make sure pending writes are done.
This is relevant for surfaces created for example with crate::PdfSurface::for_stream
.
Use Box::downcast
to recover the concrete stream type.
Panics
This method panics if:
- This method was already called for this surface, or
- This surface was not created with an output stream in the first place, or
- A previous write to this surface panicked, or
- A previous write happened while another write was ongoing, or
- A write is ongoing now.
The latter two cases can only occur with a pathological output stream type
that accesses the same surface again from Write::write_all
.
Trait Implementations§
source§impl FromGlibPtrBorrow<*mut cairo_surface_t> for PsSurface
impl FromGlibPtrBorrow<*mut cairo_surface_t> for PsSurface
source§impl FromGlibPtrFull<*mut cairo_surface_t> for PsSurface
impl FromGlibPtrFull<*mut cairo_surface_t> for PsSurface
source§impl FromGlibPtrNone<*mut cairo_surface_t> for PsSurface
impl FromGlibPtrNone<*mut cairo_surface_t> for PsSurface
source§impl<'a> FromValue<'a> for &'a PsSurface
impl<'a> FromValue<'a> for &'a PsSurface
§type Checker = GenericValueTypeOrNoneChecker<&'a PsSurface>
type Checker = GenericValueTypeOrNoneChecker<&'a PsSurface>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl<'a> FromValue<'a> for PsSurface
impl<'a> FromValue<'a> for PsSurface
§type Checker = GenericValueTypeOrNoneChecker<PsSurface>
type Checker = GenericValueTypeOrNoneChecker<PsSurface>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl IntoGlibPtr<*mut cairo_surface_t> for PsSurface
impl IntoGlibPtr<*mut cairo_surface_t> for PsSurface
source§unsafe fn into_glib_ptr(self) -> *mut cairo_surface_t
unsafe fn into_glib_ptr(self) -> *mut cairo_surface_t
source§impl StaticType for PsSurface
impl StaticType for PsSurface
source§fn static_type() -> Type
fn static_type() -> Type
Self
.