Files
adler32
ahash
aho_corasick
alga
alga_derive
alsa_sys
amethyst
amethyst_animation
amethyst_assets
amethyst_audio
amethyst_config
amethyst_controls
amethyst_core
amethyst_derive
amethyst_error
amethyst_input
amethyst_locale
amethyst_network
amethyst_rendy
amethyst_ui
amethyst_utils
amethyst_window
andrew
approx
arrayvec
ash
atom
atty
backtrace
backtrace_sys
base64
bincode
bitflags
byteorder
bytes
c2_chacha
cfg_if
cgmath
chrono
claxon
clipboard
color_quant
colored
colorful
const_random
const_random_macro
cookie
cookie_store
cpal
crc
crc32fast
crossbeam_channel
crossbeam_deque
crossbeam_epoch
crossbeam_queue
crossbeam_utils
ctor
debugid
deflate
derivative
derive_new
dirs
dlib
downcast_rs
dtoa
edit_distance
either
encoding_rs
env_logger
erased_serde
err_derive
error_chain
euclid
euclid_macros
expat_sys
failure
failure_derive
fern
flate2
float_ord
fluent
fluent_bundle
fluent_locale
fluent_syntax
fnv
font_kit
fontconfig
fontconfig_sys
foreign_types
foreign_types_shared
freetype
freetype_sys
futures
futures_cpupool
fxhash
generic_array
genmesh
getrandom
getset
gfx_backend_vulkan
gfx_hal
ghost
gif
glsl_layout
glsl_layout_derive
glyph_brush
glyph_brush_layout
h2
hashbrown
heck
hibitset
hostname
hound
http
http_body
httparse
httpdate
humantime
hyper
hyper_tls
idna
im
image
indexmap
inflate
intl_pluralrules
inventory
inventory_impl
iovec
itertools
itoa
jpeg_decoder
laminar
lazy_static
lewton
lexical
lexical_core
libc
libloading
libm
line_drawing
linked_hash_map
lock_api
log
lyon_geom
lyon_path
lzw
matches
matrixmultiply
maybe_uninit
memchr
memmap
memoffset
mime
mime_guess
minimp3
minimp3_sys
miniz_oxide
mint
minterpolate
mio
mopa
nalgebra
base
geometry
linalg
native_tls
net2
nix
nodrop
num
num_bigint
num_complex
num_cpus
num_derive
num_integer
num_iter
num_rational
num_traits
objekt
ogg
openssl
openssl_probe
openssl_sys
ordered_float
owning_ref
palette
palette_derive
parking_lot
parking_lot_core
paste
paste_impl
percent_encoding
phf
phf_shared
png
ppv_lite86
proc_macro2
proc_macro_hack
proc_macro_roids
publicsuffix
quick_error
quickcheck
quote
rand
rand_chacha
rand_core
rand_hc
rand_isaac
rand_jitter
rand_os
rand_pcg
rand_xorshift
rawpointer
rayon
rayon_core
regex
regex_syntax
relevant
rendy
rendy_chain
rendy_command
rendy_descriptor
rendy_factory
rendy_frame
rendy_graph
rendy_memory
rendy_mesh
rendy_resource
rendy_shader
rendy_texture
rendy_util
rendy_wsi
rental
rental_impl
reqwest
rgb
rodio
ron
rustc_demangle
rustc_hash
rustc_version
rustc_version_runtime
rusttype
ryu
same_file
scoped_threadpool
scopeguard
semver
semver_parser
sentry
sentry_types
serde
serde_bytes
serde_derive
serde_json
serde_urlencoded
shared_library
shred
shred_derive
shrev
singularity_rs
siphasher
sized_chunks
slab
slice_deque
smallvec
smithay_client_toolkit
specs
specs_derive
specs_hierarchy
stable_deref_trait
stackvector
static_assertions
stb_truetype
string
syn
synstructure
termcolor
thread_local
thread_profiler
tiff
time
tokio
tokio_buf
tokio_current_thread
tokio_executor
tokio_io
tokio_reactor
tokio_sync
tokio_tcp
tokio_threadpool
tokio_timer
try_from
try_lock
tuple_utils
twox_hash
typenum
uname
unic_langid
unic_langid_impl
unic_langid_macros
unic_langid_macros_impl
unicase
unicode_bidi
unicode_normalization
unicode_segmentation
unicode_xid
unreachable
url
url_serde
uuid
void
walkdir
want
wavefront_obj
wayland_client
wayland_commons
wayland_protocols
wayland_sys
winapi
winconsole
winit
x11
x11_clipboard
x11_dl
xcb
xdg
xi_unicode
xml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
// font-kit/src/handle.rs
//
// Copyright © 2018 The Pathfinder Project Developers.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Encapsulates the information needed to locate and open a font.
//!
//! This is either the path to the font or the raw in-memory font data.
//!
//! To open the font referenced by a handle, use a loader.

use std::path::PathBuf;
use std::sync::Arc;

use error::FontLoadingError;
use font::Font;

/// Encapsulates the information needed to locate and open a font.
///
/// This is either the path to the font or the raw in-memory font data.
///
/// To open the font referenced by a handle, use a loader.
#[derive(Debug, Clone)]
pub enum Handle {
    /// A font on disk referenced by a path.
    Path {
        /// The path to the font.
        path: PathBuf,
        /// The index of the font, if the path refers to a collection.
        ///
        /// If the path refers to a single font, this value will be 0.
        font_index: u32,
    },
    /// A font in memory.
    Memory {
        /// The raw TrueType/OpenType/etc. data that makes up this font.
        bytes: Arc<Vec<u8>>,
        /// The index of the font, if the memory consists of a collection.
        ///
        /// If the memory consists of a single font, this value will be 0.
        font_index: u32,
    },
}

impl Handle {
    /// Creates a new handle from a path.
    ///
    /// `font_index` specifies the index of the font to choose if the path points to a font
    /// collection. If the path points to a single font file, pass 0.
    #[inline]
    pub fn from_path(path: PathBuf, font_index: u32) -> Handle {
        Handle::Path {
            path,
            font_index,
        }
    }

    /// Creates a new handle from raw TTF/OTF/etc. data in memory.
    ///
    /// `font_index` specifies the index of the font to choose if the memory represents a font
    /// collection. If the memory represents a single font file, pass 0.
    #[inline]
    pub fn from_memory(bytes: Arc<Vec<u8>>, font_index: u32) -> Handle {
        Handle::Memory {
            bytes,
            font_index,
        }
    }

    /// A convenience method to load this handle with the default loader, producing a Font.
    #[inline]
    pub fn load(&self) -> Result<Font, FontLoadingError> {
        Font::from_handle(self)
    }
}