rsfdisk 0.2.0

Safe Rust wrapper around the `util-linux/libfdisk` C library
Documentation 
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

// Copyright (c) 2023 Nick Piaddo
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Library-level error module.

// From dependency library
use thiserror::Error;

// From standard library

// From this library
use crate::core::errors::ConversionError;
use crate::core::errors::GenIteratorError;
use crate::core::errors::HeaderEntryContentError;
use crate::core::errors::ParserError;
use crate::core::errors::PartitionBuilderError;
use crate::core::errors::PartitionError;
use crate::core::errors::PartitionIterError;
use crate::core::errors::PartitionKindBuilderError;
use crate::core::errors::PartitionKindError;
use crate::core::errors::PartitionListError;
use crate::core::errors::PartitionTableError;
use crate::core::errors::PromptError;
use crate::core::errors::ScriptError;

use crate::fdisk::FdiskBuilderError;
use crate::fdisk::FdiskError;

use crate::core::utils::version::VersionError;

/// A specialized [`Result`](std::result::Result) type for `rsfdisk`.
///
/// This typedef is generally used at the program-level to avoid writing out [`RsFdiskError`]
/// directly, and is, otherwise, a direct mapping to [`Result`](std::result::Result).
#[allow(dead_code)]
pub type Result<T> = std::result::Result<T, RsFdiskError>;

/// Library-level runtime errors.
///
/// This enum includes all variants of error types susceptible to occur in the library. Other, more
/// granular error types, are automatically converted to an `RsFdiskError` when needed.
///
/// # Examples
/// ----
///
/// ```
/// fn main() -> rsfdisk::Result<()> {
///
///     Ok(())
/// }
/// ```
#[derive(Debug, Error, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[non_exhaustive]
pub enum RsFdiskError {
    #[error(transparent)]
    Conversion(#[from] ConversionError),

    #[error(transparent)]
    Fdisk(#[from] FdiskError),

    #[error(transparent)]
    FdiskBuilder(#[from] FdiskBuilderError),

    #[error(transparent)]
    GenIterator(#[from] GenIteratorError),

    #[error(transparent)]
    HeaderEntryContent(#[from] HeaderEntryContentError),

    #[error(transparent)]
    Parser(#[from] ParserError),

    #[error(transparent)]
    Partition(#[from] PartitionError),

    #[error(transparent)]
    PartitionBuilder(#[from] PartitionBuilderError),

    #[error(transparent)]
    PartitionIter(#[from] PartitionIterError),

    #[error(transparent)]
    PartitionKind(#[from] PartitionKindError),

    #[error(transparent)]
    PartitionKindBuilder(#[from] PartitionKindBuilderError),

    #[error(transparent)]
    PartitionList(#[from] PartitionListError),

    #[error(transparent)]
    PartitionTable(#[from] PartitionTableError),

    #[error(transparent)]
    Prompt(#[from] PromptError),

    #[error(transparent)]
    Script(#[from] ScriptError),

    #[error(transparent)]
    Version(#[from] VersionError),
}