Struct FileBreadcrumb

Source
pub struct FileBreadcrumb<A = ()> { /* private fields */ }
Expand description

Horizontal cumulative-path breadcrumb for a file URI.

Without an activation handler segments are plain text. With one, each segment becomes a text-only button; separators remain non-interactive. A is the surrounding application’s action type.

§Examples

use ailloli_ui_fs::FileUri;
use ailloli_ui_widgets::files::FileBreadcrumb;
let breadcrumb = FileBreadcrumb::<()>::new(FileUri::parse("file:///repo/src/lib.rs")?)
    .root_label("workspace");
let _ = breadcrumb;

Implementations§

Source§

impl<A: 'static> FileBreadcrumb<A>

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().width(120.0);
let _ = widget;
Source

pub fn height(self, value: impl Into<Length>) -> Self

Sets preferred height from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().height(40.0);
let _ = widget;
Source

pub fn min_width(self, value: impl Into<Length>) -> Self

Sets the minimum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_width(40.0);
let _ = widget;
Source

pub fn max_width(self, value: impl Into<Length>) -> Self

Sets the maximum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_width(320.0);
let _ = widget;
Source

pub fn min_height(self, value: impl Into<Length>) -> Self

Sets the minimum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_height(24.0);
let _ = widget;
Source

pub fn max_height(self, value: impl Into<Length>) -> Self

Sets the maximum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_height(240.0);
let _ = widget;
Source

pub fn fill(self) -> Self

Sets both preferred axes to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill();
let _ = widget;
Source

pub fn fill_width(self) -> Self

Sets preferred width to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_width();
let _ = widget;
Source

pub fn fill_height(self) -> Self

Sets preferred height to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_height();
let _ = widget;
Source

pub fn margin(self, value: f32) -> Self

Sets uniform outer margin in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().margin(8.0);
let _ = widget;
Source

pub fn padding(self, value: f32) -> Self

Sets uniform inner padding in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().padding(8.0);
let _ = widget;
Source

pub fn flex_grow(self) -> Self

Sets flex-grow weight to one.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow();
let _ = widget;
Source

pub fn flex_grow_by(self, value: f32) -> Self

Sets a dimensionless flex-grow weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow_by(2.0);
let _ = widget;
Source

pub fn flex_shrink(self, value: f32) -> Self

Sets a dimensionless flex-shrink weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_shrink(1.0);
let _ = widget;
Source

pub fn flex_basis(self, value: impl Into<Length>) -> Self

Sets the preferred main-axis flex basis.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_basis(80.0);
let _ = widget;
Source

pub fn align_self(self, value: AlignItems) -> Self

Overrides cross-axis alignment for this flex item.

§Examples
use ailloli_ui_core::style::AlignItems;
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().align_self(AlignItems::Center);
let _ = widget;
Source§

impl<A: 'static> FileBreadcrumb<A>

Source

pub fn new(uri: FileUri) -> Self

Creates a breadcrumb for uri with no base, root label, or callback.

§Examples
use ailloli_ui_fs::FileUri;
use ailloli_ui_widgets::files::FileBreadcrumb;
let breadcrumb = FileBreadcrumb::<()>::new(FileUri::parse("file:///repo/main.rs")?);
let _ = breadcrumb;
Source

pub fn local_path(path: impl Into<PathBuf>) -> Result<Self, FileError>

Creates a breadcrumb from an absolute or working-directory-relative path.

Existing paths are canonicalized; nonexistent paths retain their joined lexical form. Relative-path resolution falls back to / only if querying the current directory fails.

§Errors

Returns [FileError] when the resulting native path cannot be represented as a local file URI, for example because a component is not valid UTF-8.

§Examples
use ailloli_ui_widgets::files::FileBreadcrumb;
let breadcrumb = FileBreadcrumb::<()>::local_path(".")?;
let _ = breadcrumb;
Source

pub fn base_uri(self, base: FileUri) -> Self

Sets the first URI shown when it matches the target location/prefix.

The base is used only when scheme and authority match and the target path starts with the base path. Otherwise the absolute URI is segmented.

§Examples
use ailloli_ui_fs::FileUri;
use ailloli_ui_widgets::files::FileBreadcrumb;
let target = FileUri::parse("file:///repo/src/lib.rs")?;
let breadcrumb = FileBreadcrumb::<()>::new(target)
    .base_uri(FileUri::parse("file:///repo")?);
let _ = breadcrumb;
Source

pub fn base_path(self, path: impl Into<PathBuf>) -> Result<Self, FileError>

Resolves a local path and sets it as the breadcrumb base URI.

Resolution and failure semantics match Self::local_path.

§Errors

Returns [FileError] if the native base cannot be converted to a URI.

§Examples
use ailloli_ui_widgets::files::FileBreadcrumb;
let breadcrumb = FileBreadcrumb::<()>::local_path(".")?.base_path(".")?;
let _ = breadcrumb;
Source

pub fn root_label(self, label: impl Into<String>) -> Self

Overrides the first visible segment label.

The label is stored verbatim, including an empty string. It does not change the segment URI or labels after index zero.

§Examples
use ailloli_ui_fs::FileUri;
use ailloli_ui_widgets::files::FileBreadcrumb;
let breadcrumb = FileBreadcrumb::<()>::new(FileUri::parse("file:///repo/src")?)
    .root_label("workspace");
let _ = breadcrumb;
Source

pub fn breadcrumb_style(self, style: FileBreadcrumbStyle) -> Self

Replaces text styles and logical-pixel child spacing.

§Examples
use ailloli_ui_fs::FileUri;
use ailloli_ui_widgets::files::{FileBreadcrumb, FileBreadcrumbStyle};
let breadcrumb = FileBreadcrumb::<()>::new(FileUri::parse("file:///repo")?)
    .breadcrumb_style(FileBreadcrumbStyle::default());
let _ = breadcrumb;
Source

pub fn on_activate( self, f: impl Fn(FileBreadcrumbSegment) -> A + 'static, ) -> Self

Maps an activated segment into an application action.

Installing this callback also changes every segment from static text to a text-only button.

§Examples
use ailloli_ui_fs::FileUri;
use ailloli_ui_widgets::files::{FileBreadcrumb, FileBreadcrumbSegment};
enum Action { Open(FileBreadcrumbSegment) }
let breadcrumb = FileBreadcrumb::<Action>::new(FileUri::parse("file:///repo")?)
    .on_activate(Action::Open);
let _ = breadcrumb;
Source

pub fn on_activate_ctx( self, f: impl Fn(&mut EventCtx<A>, FileBreadcrumbSegment) + 'static, ) -> Self

Handles activation with direct access to the event context.

Use this form to dispatch zero or multiple actions or request additional runtime work.

§Examples
use ailloli_ui_fs::FileUri;
use ailloli_ui_widgets::files::FileBreadcrumb;
let breadcrumb = FileBreadcrumb::<()>::new(FileUri::parse("file:///repo")?)
    .on_activate_ctx(|_ctx, _segment| {});
let _ = breadcrumb;

Trait Implementations§

Source§

impl<A: 'static> IntoView<A> for FileBreadcrumb<A>

Converts segments into a nowrap, vertically centered row of text/buttons.

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl<A: 'static> LayoutExt for FileBreadcrumb<A>

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

Auto Trait Implementations§

§

impl<A> Freeze for FileBreadcrumb<A>

§

impl<A = ()> !RefUnwindSafe for FileBreadcrumb<A>

§

impl<A = ()> !Send for FileBreadcrumb<A>

§

impl<A = ()> !Sync for FileBreadcrumb<A>

§

impl<A> Unpin for FileBreadcrumb<A>

§

impl<A = ()> !UnwindSafe for FileBreadcrumb<A>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,