Struct Path

pub struct Path { /* private fields */ }

Collection of the SubPath treated as a single unit. Represents the same concept as an SVG path

Implementations

impl Path

pub fn new( segments: Vec<Segment>, subpaths: Vec<usize>, closed: Vec<bool>, ) -> Self

pub fn empty() -> Self

Create empty path

pub fn is_empty(&self) -> bool

Check if the path is empty

pub fn len(&self) -> usize

Number of sub-paths in the path

pub fn winding_at(&self, point: impl Into<Point>) -> i32

Calculate winding number of a point

pub fn get(&self, index: usize) -> Option<SubPath<'_>>

Get sub-path

pub fn subpaths(&self) -> PathIter<'_>

List of sub-paths

pub fn push(&mut self, segments: &[Segment], closed: bool)

pub fn builder() -> PathBuilder

Convenience method to create PathBuilder

pub fn into_builder(self) -> PathBuilder

Convert path into a path builder so it can be extended

pub fn transform(&mut self, tr: Transform)

Apply transformation to the path in place

pub fn segments_count(&self) -> usize

Number of segments in the path

pub fn stroke(&self, style: StrokeStyle) -> Path

Stroke path

Stroked path is the path constructed from original by offsetting by distance/2 and joining it with the path offset by -distance/2.

pub fn flatten( &self, tr: Transform, flatness: Scalar, close: bool, ) -> impl Iterator<Item = Line> + '_

Convert path to an iterator over line segments

pub fn bbox(&self, tr: Transform) -> Option<BBox>

Bounding box of the path after provided transformation is applied.

pub fn size(&self, tr: Transform) -> Option<(Size, Transform, Point)>

Calculate size of the image required to render the path

Returns:

• Size of the image
• Transformation required
• Position of lowest x and y point of the image

pub fn reverse(&mut self)

Reverse order and direction of all segments

pub fn fill<R, P, I>( &self, rasterizer: R, tr: Transform, fill_rule: FillRule, paint: P, img: I, ) -> I

where R: Rasterizer, P: Paint, I: ImageMut<Pixel = LinColor>,

Fill path with the provided paint

pub fn mask<R, I>( &self, rasterizer: R, tr: Transform, fill_rule: FillRule, img: I, ) -> I

where R: Rasterizer, I: ImageMut<Pixel = Scalar>,

Rasterize mast for the path in into a provided image.

Everything that is outside of the image will be cropped. Image is assumed to contain zeros.

pub fn write_svg_path(&self, out: impl Write) -> Result<()>

Save path in SVG path format.

pub fn read_svg_path(input: impl Read) -> Result<Self>

Load path from SVG path representation

pub fn display(&self, relative: bool, tr: Transform) -> PathSvgDisplay<'_>

pub fn verbose_debug(&self) -> PathVerboseDebug<'_>

Returns struct that prints command per line on debug formatting.

Trait Implementations

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Default for Path

fn default() -> Path

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Path

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Path

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

Formats the value using the given formatter.

impl<'a> Extend<SubPath<'a>> for Path

fn extend<T: IntoIterator<Item = SubPath<'a>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromStr for Path

type Err = SvgParserError

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Path, Self::Err>

Parses a string s to return a value of this type.

impl<'a> IntoIterator for &'a Path

type Item = SubPath<'a>

The type of the elements being iterated over.

type IntoIter = PathIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Path

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Path

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Path