livekit-data-stream 0.1.1

Data stream core logic for LiveKit
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
103
104
105
106
107
108
109
110

// Copyright 2026 LiveKit, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use thiserror::Error;

/// Error returned by the packet transport when a data-stream packet fails to send.
///
/// The stream managers only need to know that a send failed (they map it to
/// [`StreamError::SendFailed`]); the concrete engine error type stays in the `livekit` crate,
/// which bridges the outgoing packet channel to the RTC engine.
#[derive(Debug, Clone)]
pub struct SendError;

/// Result type for data stream operations.
pub type StreamResult<T> = Result<T, StreamError>;

/// Error type for data stream operations.
#[derive(Debug, Error)]
pub enum StreamError {
    // TODO(ladvoc): standardize error cases and expose over FFI.
    #[error("stream has already been closed")]
    AlreadyClosed,

    #[error("stream closed abnormally: {0}")]
    AbnormalEnd(String),

    #[error("UTF-8 decoding error: {0}")]
    Utf8(#[from] std::string::FromUtf8Error),

    #[error("incoming header was invalid")]
    InvalidHeader,

    #[error("expected chunk index to be exactly one more than the previous")]
    MissedChunk,

    #[error("read length exceeded total length specified in stream header")]
    LengthExceeded,

    #[error("stream data is incomplete")]
    Incomplete,

    #[error("unable to send packet")]
    SendFailed,

    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    #[error("internal error")]
    Internal,

    #[error("encryption type mismatch")]
    EncryptionTypeMismatch,

    #[error("stream header exceeds maximum size")]
    HeaderTooLarge,

    #[error("stream payload exceeds maximum size")]
    PayloadTooLarge,

    #[error("decompression failed")]
    Decompression,

    #[error("file name must be a plain file name without path separators or '..'")]
    InvalidFileName,
}

/// Progress of a data stream.
#[derive(Clone, Copy, Default, Debug, Hash, Eq, PartialEq)]
pub struct StreamProgress {
    pub(crate) chunk_index: u64,
    /// Number of bytes read or written so far.
    pub(crate) bytes_processed: u64,
    /// Total number of bytes expected to be read or written for finite streams.
    pub(crate) bytes_total: Option<u64>,
}

impl StreamProgress {
    /// Number of bytes read or written so far.
    pub fn bytes_processed(&self) -> u64 {
        self.bytes_processed
    }

    /// Total number of bytes expected for finite streams, or `None` for streams of unknown size.
    pub fn bytes_total(&self) -> Option<u64> {
        self.bytes_total
    }

    /// Returns the completion fraction (`0.0..=1.0`) for finite streams, or `None` for streams of
    /// unknown size.
    pub fn percentage(&self) -> Option<f32> {
        self.bytes_total.map(|total| {
            if total == 0 {
                1.0
            } else {
                self.bytes_processed as f32 / total as f32
            }
        })
    }
}