qubit-codec-text 0.1.0

Buffer-oriented text encoding and decoding utilities for Rust
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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
use crate::MalformedAction;

/// Malformed-input policy used by charset decoders and converters.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub struct CharsetDecodePolicy {
    /// Action used for malformed input units.
    malformed_action: MalformedAction,
    /// Replacement character used by [`MalformedAction::Replace`].
    replacement: char,
}

impl CharsetDecodePolicy {
    /// Default replacement character used when malformed input is replaced.
    pub const DEFAULT_REPLACEMENT: char = '\u{fffd}';

    /// Creates a malformed-input policy.
    #[must_use]
    #[inline(always)]
    pub const fn new(
        malformed_action: MalformedAction,
        replacement: char,
    ) -> Self {
        Self {
            malformed_action,
            replacement,
        }
    }

    /// Creates a replacement policy.
    #[must_use]
    #[inline(always)]
    pub const fn replace(replacement: char) -> Self {
        Self::new(MalformedAction::Replace, replacement)
    }

    /// Creates an ignore policy with the default replacement retained for
    /// metadata.
    #[must_use]
    #[inline(always)]
    pub const fn ignore() -> Self {
        Self::ignore_with_replacement(Self::DEFAULT_REPLACEMENT)
    }

    /// Creates an ignore policy with explicit replacement metadata.
    #[must_use]
    #[inline(always)]
    pub const fn ignore_with_replacement(replacement: char) -> Self {
        Self::new(MalformedAction::Ignore, replacement)
    }

    /// Creates a report policy with the default replacement retained for
    /// metadata.
    #[must_use]
    #[inline(always)]
    pub const fn report() -> Self {
        Self::new(MalformedAction::Report, Self::DEFAULT_REPLACEMENT)
    }

    /// Returns the malformed-input action.
    #[must_use]
    #[inline(always)]
    pub const fn malformed_action(self) -> MalformedAction {
        self.malformed_action
    }

    /// Returns the replacement character.
    #[must_use]
    #[inline(always)]
    pub const fn replacement(self) -> char {
        self.replacement
    }
}

impl Default for CharsetDecodePolicy {
    #[inline(always)]
    fn default() -> Self {
        Self::replace(Self::DEFAULT_REPLACEMENT)
    }
}