Struct cosmic::iced_widget::renderer::graphics::text::cosmic_text::fontdb::Database
source · pub struct Database { /* private fields */ }
Expand description
A font database.
Implementations§
source§impl Database
impl Database
sourcepub fn new() -> Database
pub fn new() -> Database
Create a new, empty Database
.
Generic font families would be set to:
serif
- Times New Romansans-serif
- Arialcursive
- Comic Sans MSfantasy
- Impact (Papyrus on macOS)monospace
- Courier New
sourcepub fn load_font_data(&mut self, data: Vec<u8>)
pub fn load_font_data(&mut self, data: Vec<u8>)
Loads a font data into the Database
.
Will load all font faces in case of a font collection.
sourcepub fn load_font_source(&mut self, source: Source) -> TinyVec<[ID; 8]>
pub fn load_font_source(&mut self, source: Source) -> TinyVec<[ID; 8]>
Loads a font from the given source into the Database
and returns
the ID of the loaded font.
Will load all font faces in case of a font collection.
sourcepub fn load_font_file<P>(&mut self, path: P) -> Result<(), Error>
pub fn load_font_file<P>(&mut self, path: P) -> Result<(), Error>
Loads a font file into the Database
.
Will load all font faces in case of a font collection.
sourcepub fn load_fonts_dir<P>(&mut self, dir: P)
pub fn load_fonts_dir<P>(&mut self, dir: P)
Loads font files from the selected directory into the Database
.
This method will scan directories recursively.
Will load ttf
, otf
, ttc
and otc
fonts.
Unlike other load_*
methods, this one doesn’t return an error.
It will simply skip malformed fonts and will print a warning into the log for each of them.
sourcepub fn load_system_fonts(&mut self)
pub fn load_system_fonts(&mut self)
Attempts to load system fonts.
Supports Windows, Linux and macOS.
System fonts loading is a surprisingly complicated task,
mostly unsolvable without interacting with system libraries.
And since fontdb
tries to be small and portable, this method
will simply scan some predefined directories.
Which means that fonts that are not in those directories must
be added manually.
sourcepub fn push_face_info(&mut self, info: FaceInfo)
pub fn push_face_info(&mut self, info: FaceInfo)
Pushes a user-provided FaceInfo
to the database.
In some cases, a caller might want to ignore the font’s metadata and provide their own.
This method doesn’t parse the source
font.
The id
field should be set to ID::dummy()
and will be then overwritten by this method.
sourcepub fn remove_face(&mut self, id: ID)
pub fn remove_face(&mut self, id: ID)
Removes a font face by id
from the database.
Returns false
while attempting to remove a non-existing font face.
Useful when you want to ignore some specific font face(s) after loading a large directory with fonts. Or a specific face from a font.
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
Returns the number of font faces in the Database
.
Note that Database
stores font faces, not fonts.
For example, if a caller will try to load a font collection (*.ttc
) that contains 5 faces,
then the Database
will load 5 font faces and this method will return 5, not 1.
sourcepub fn set_serif_family<S>(&mut self, family: S)
pub fn set_serif_family<S>(&mut self, family: S)
Sets the family that will be used by Family::Serif
.
sourcepub fn set_sans_serif_family<S>(&mut self, family: S)
pub fn set_sans_serif_family<S>(&mut self, family: S)
Sets the family that will be used by Family::SansSerif
.
sourcepub fn set_cursive_family<S>(&mut self, family: S)
pub fn set_cursive_family<S>(&mut self, family: S)
Sets the family that will be used by Family::Cursive
.
sourcepub fn set_fantasy_family<S>(&mut self, family: S)
pub fn set_fantasy_family<S>(&mut self, family: S)
Sets the family that will be used by Family::Fantasy
.
sourcepub fn set_monospace_family<S>(&mut self, family: S)
pub fn set_monospace_family<S>(&mut self, family: S)
Sets the family that will be used by Family::Monospace
.
sourcepub fn family_name<'a>(&'a self, family: &'a Family<'_>) -> &'a str
pub fn family_name<'a>(&'a self, family: &'a Family<'_>) -> &'a str
Returns the generic family name or the Family::Name
itself.
Generic family names should be set via Database::set_*_family
methods.
sourcepub fn query(&self, query: &Query<'_>) -> Option<ID>
pub fn query(&self, query: &Query<'_>) -> Option<ID>
Performs a CSS-like query and returns the best matched font face.
sourcepub fn faces(&self) -> impl Iterator<Item = &FaceInfo>
pub fn faces(&self) -> impl Iterator<Item = &FaceInfo>
Returns an iterator over the internal storage.
This can be used for manual font matching.
sourcepub fn face(&self, id: ID) -> Option<&FaceInfo>
pub fn face(&self, id: ID) -> Option<&FaceInfo>
Selects a FaceInfo
by id
.
Returns None
if a face with such ID was already removed,
or this ID belong to the other Database
.
sourcepub fn face_source(&self, id: ID) -> Option<(Source, u32)>
pub fn face_source(&self, id: ID) -> Option<(Source, u32)>
Returns font face storage and the face index by ID
.
sourcepub fn with_face_data<P, T>(&self, id: ID, p: P) -> Option<T>
pub fn with_face_data<P, T>(&self, id: ID, p: P) -> Option<T>
Executes a closure with a font’s data.
We can’t return a reference to a font binary data because of lifetimes. So instead, you can use this method to process font’s data.
The closure accepts raw font data and font face index.
In case of Source::File
, the font file will be memory mapped.
Returns None
when font file loading failed.
§Example
let is_variable = db.with_face_data(id, |font_data, face_index| {
let font = ttf_parser::Face::from_slice(font_data, face_index).unwrap();
font.is_variable()
})?;
Makes the font data that backs the specified face id shared so that the application can hold a reference to it.
§Safety
If the face originates from a file from disk, then the file is mapped from disk. This is unsafe as another process may make changes to the file on disk, which may become visible in this process’ mapping and possibly cause crashes.
If the underlying font provides multiple faces, then all faces are updated to participate in the data sharing. If the face was previously marked for data sharing, then this function will return a clone of the existing reference.
Transfers ownership of shared font data back to the font database. This is the reverse operation
of Self::make_shared_face_data
. If the font data belonging to the specified face is mapped
from a file on disk, then that mapping is closed and the data becomes private to the process again.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Database
impl !RefUnwindSafe for Database
impl Send for Database
impl Sync for Database
impl Unpin for Database
impl !UnwindSafe for Database
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
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
source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§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> ⓘ
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> ⓘ
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 moresource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more