pub struct Sketchbook { /* private fields */ }Expand description
Collection for discovering and caching sketch metadata.
Implementations§
Source§impl Sketchbook
impl Sketchbook
Sourcepub fn new() -> Result<Self>
pub fn new() -> Result<Self>
Create a new sketchbook.
Uses the platform’s cache directory (~/.cache/bbx_draw/sketches on Linux, ~/Library/Caches/bbx_draw/sketches on macOS, etc.).
Sourcepub fn with_cache_dir(cache_dir: PathBuf) -> Result<Self>
pub fn with_cache_dir(cache_dir: PathBuf) -> Result<Self>
Create a sketchbook with a custom cache directory.
Sourcepub fn discover(&mut self, search_dir: &PathBuf) -> Result<usize>
pub fn discover(&mut self, search_dir: &PathBuf) -> Result<usize>
Discover sketches in a directory and update the sketchbook.
Sourcepub fn list(&self) -> &[SketchMetadata]
pub fn list(&self) -> &[SketchMetadata]
List all registered sketches.
Sourcepub fn get(&self, name: &str) -> Option<&SketchMetadata>
pub fn get(&self, name: &str) -> Option<&SketchMetadata>
Get a sketch by name.
Sourcepub fn remove(&mut self, name: &str) -> Option<SketchMetadata>
pub fn remove(&mut self, name: &str) -> Option<SketchMetadata>
Remove a sketch from the sketchbook.
Sourcepub fn register(&mut self, metadata: SketchMetadata) -> Result<()>
pub fn register(&mut self, metadata: SketchMetadata) -> Result<()>
Add or update a sketch in the sketchbook.
Auto Trait Implementations§
impl Freeze for Sketchbook
impl RefUnwindSafe for Sketchbook
impl Send for Sketchbook
impl Sync for Sketchbook
impl Unpin for Sketchbook
impl UnwindSafe for Sketchbook
Blanket Implementations§
Source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
Source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<Swp, Dwp, T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<Swp, Dwp, T>,
Convert the source color to the destination color using the specified
method
Source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
Convert the source color to the destination color using the bradford
method by default
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T, U> ConvertInto<U> for Twhere
U: ConvertFrom<T>,
impl<T, U> ConvertInto<U> for Twhere
U: ConvertFrom<T>,
Source§fn convert_into(self) -> U
fn convert_into(self) -> U
Convert into T with values clamped to the color defined bounds Read more
Source§fn convert_unclamped_into(self) -> U
fn convert_unclamped_into(self) -> U
Convert into T. The resulting color might be invalid in its color space Read more
Source§fn try_convert_into(self) -> Result<U, OutOfBounds<U>>
fn try_convert_into(self) -> Result<U, OutOfBounds<U>>
Convert into T, returning ok if the color is inside of its defined range,
otherwise an
OutOfBounds error is returned which contains the unclamped color. Read moreSource§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more