util/src/lib.rs


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

#![warn(missing_docs)]
//! Small things that couldn't fit elsewhere in Kittybox, yet may be
//! useful on their own or in multiple Kittybox crates.
//!
//! Some things are gated behind features, namely:
//!  - `fs` - enables use of filesystem-related utilities
#[derive(Debug, Default)]
/// Common types of webmentions.
pub enum MentionType {
    /// Corresponds to a `u-in-reply-to` link.
    Reply,
    /// Corresponds to a `u-like-of` link.
    Like,
    /// Corresponds to a `u-repost-of` link.
    Repost,
    /// Corresponds to a `u-bookmark-of` link.
    Bookmark,
    /// A plain link without MF2 annotations.
    #[default]
    Mention
}

/// Common data-types useful in creating smart authentication systems.
pub mod auth {
    /// Various types of credentials Kittybox can use.
    #[derive(PartialEq, Eq, Hash, Clone, Copy)]
    pub enum EnrolledCredential {
        /// Denotes availability of a password. Passwords can be
        /// used to recover from a lost passkey.
        Password,
        /// Denotes availability of one or more passkeys.
        WebAuthn
    }
}

pub mod micropub;

/// A collection of traits for implementing a robust job queue.
pub mod queue;

#[cfg(feature = "fs")]
/// Commonly-used operations with the file system in Kittybox's
/// underlying storage mechanisms.
pub mod fs;