Enum ShapeBorder 

pub enum ShapeBorder {
    RoundedRectangle {
        radius: BorderRadius,
        side: BorderSide,
    },
    Stadium {
        side: BorderSide,
    },
    Circle {
        eccentricity: f32,
        side: BorderSide,
    },
    Beveled {
        radius: BorderRadius,
        side: BorderSide,
    },
}

What a decoration is made of — its shape, its sides, its border’s two forms, its shadows’ blur — and the shapes a border can take. What shape a box is (shape_border.dart), and the edge around it.

Copy, deliberately: this is meant to sit in a theme, and the theme’s per-widget structs are copied wholesale. A shape with a variable number of corners — the reference’s StarBorder, LinearBorder — would end that, and is not here.

Variants

RoundedRectangle

Corners rounded by a radius each (rounded_rectangle_border.dart).

Fields

radius: BorderRadius

The corner radii.

side: BorderSide

The edge drawn around the shape.

Stadium

A pill: the ends are semicircles, whatever the box’s proportions (stadium_border.dart:95). What a chip is, and what a navigation indicator is.

Fields

side: BorderSide

The edge drawn around the shape.

Circle

A circle inscribed in the box, or an ellipse on the way to filling it (circle_border.dart:126).

Fields

eccentricity: f32

0.0 — a true circle, in a square taken out of the middle of the box. 1.0 — an ellipse filling the box entirely. Between them, the circle grows towards the ellipse along the box’s longer axis.

side: BorderSide

The edge drawn around the shape.

Beveled

Corners cut off straight rather than rounded (beveled_rectangle_border.dart). The one shape here that is not a rounded rectangle in disguise.

Fields

radius: BorderRadius

The corner radii, before bevelling.

side: BorderSide

The edge drawn around the shape.

Implementations

impl ShapeBorder

pub fn rounded(radius: impl Into<BorderRadius>) -> ShapeBorder

A rectangle with these corners and no edge.

pub const fn stadium() -> ShapeBorder

A pill with no edge.

pub const fn circle() -> ShapeBorder

A circle with no edge.

pub fn beveled(radius: impl Into<BorderRadius>) -> ShapeBorder

A rectangle with these corners cut off straight, and no edge.

pub fn with_side(self, side: BorderSide) -> ShapeBorder

The same shape with an edge around it (the reference’s copyWith(side:)).

pub fn side(&self) -> BorderSide

The edge around it.

pub fn as_rounded(&self, rect: Rect) -> Option<(Rect, BorderRadius)>

The rounded rectangle this shape is inside rect: the box to draw and the radii to draw it with — or None when the outline is not one and wants outline.

A stadium’s radius is half its short side (stadium_border.dart:95); a circle’s box is the one _adjustRect takes out of the middle (circle_border.dart:126), with half its short side. Saying it this way is what keeps three shapes out of the path renderer.

pub fn outline(&self, rect: Rect) -> Path

The outline, as a path — for every shape, including the three that did not need one.

Trait Implementations

impl Clone for ShapeBorder

fn clone(&self) -> ShapeBorder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ShapeBorder

impl Debug for ShapeBorder

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

Formats the value using the given formatter.

impl Default for ShapeBorder

fn default() -> ShapeBorder

Returns the “default value” for a type.

impl PartialEq for ShapeBorder

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ShapeBorder