Struct Stroke 

pub struct Stroke {
    pub color: Color,
    pub width: f64,
    pub cap: LineCap,
    pub join: LineJoin,
    pub miter_limit: MiterLimit,
    pub dash: Option<Dash>,
}

A stroke’s colour, width and pen shape, in canvas units.

The fields stay public and every one but color and width has a default, so Stroke { cap: LineCap::Round, ..Stroke::new(color, 1.0) } works and the four settings ISO 32000-1 §8.4.3.3-§8.4.3.6 name are reachable without builder ceremony. Stroke::new keeps meaning what it always meant: PDF’s own defaults — butt cap, miter join, miter limit 10, no dash.

Fields

color: Color

The colour. Its alpha is honoured, as an /ExtGState /CA.

width: f64

The line width in canvas units — page points.

cap: LineCap

How the open ends of a subpath are drawn. J.

join: LineJoin

How two segments meet at a corner. j.

miter_limit: MiterLimit

Where a LineJoin::Miter corner becomes a bevel instead, as the ratio of miter length to line width. M.

dash: Option<Dash>

The on/off pattern, or None for a solid line. d.

Implementations

impl Stroke

pub fn new(color: Color, width: f64) -> Self

A solid stroke of color at width points, with PDF’s default pen: butt cap, miter join, miter limit 10.

let hairline = pdfrum::Stroke::new(pdfrum::Color::BLACK, 0.5);
assert_eq!(hairline.width, 0.5);
assert_eq!(hairline.cap, pdfrum::LineCap::Butt);
assert!(hairline.dash.is_none());

pub fn with_cap(self, cap: LineCap) -> Self

The same stroke with cap at its open ends.

use pdfrum::{Color, LineCap, Stroke};

let round = Stroke::new(Color::BLACK, 4.0).with_cap(LineCap::Round);
assert_eq!(round.cap, LineCap::Round);

pub fn with_join(self, join: LineJoin) -> Self

The same stroke with join at its corners.

use pdfrum::{Color, LineJoin, Stroke};

let soft = Stroke::new(Color::BLACK, 4.0).with_join(LineJoin::Round);
assert_eq!(soft.join, LineJoin::Round);

pub fn with_miter_limit(self, limit: MiterLimit) -> Self

The same stroke with limit on its miter joins.

use pdfrum::{Color, MiterLimit, Stroke};

let blunt = Stroke::new(Color::BLACK, 4.0).with_miter_limit(MiterLimit::new(2.0));
assert_eq!(blunt.miter_limit.get(), 2.0);

pub fn with_dash(self, dash: Dash) -> Self

The same stroke dashed by dash.

use pdfrum::{Color, Dash, Stroke};

let dashed = Stroke::new(Color::BLACK, 1.0)
    .with_dash(Dash::new(&[4.0, 2.0], 0.0).expect("a valid dash"));
assert!(dashed.dash.is_some());

Trait Implementations

impl Clone for Stroke

fn clone(&self) -> Stroke

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Stroke

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Stroke

fn eq(&self, other: &Stroke) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Stroke