matrix-sdk-indexeddb 0.17.0

Web's IndexedDB Storage backend for matrix-sdk
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

// Copyright 2025 The Matrix.org Foundation C.I.C.
//
// 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 crate::{
    media_store::{
        serializer::indexed_types::{IndexedMediaContentId, IndexedMediaContentSize},
        types::UnixTime,
    },
    serializer::indexed_type::constants::{
        INDEXED_KEY_LOWER_UUID, INDEXED_KEY_UPPER_DURATION_SECONDS, INDEXED_KEY_UPPER_UUID,
    },
};

/// An [`IndexedMediaContentSize`] set to it's minimal value - i.e., `0`.
///
/// This value is useful for constructing a key range over all keys which
/// contain [`IndexedMediaContentSize`] values when used in conjunction with
/// [`INDEXED_KEY_UPPER_MEDIA_CONTENT_SIZE`].
pub const INDEXED_KEY_LOWER_MEDIA_CONTENT_SIZE: IndexedMediaContentSize = 0;

/// An [`IndexedMediaContentSize`] set to [`js_sys::Number::MAX_SAFE_INTEGER`].
/// Note that this restricts the size of [`IndexedMedia::content`], which
/// ultimately restricts the size of [`Media::content`].
///
/// This value is useful for constructing a key range over all keys which
/// contain [`IndexedMediaContentSize`] values when used in conjunction with
/// [`INDEXED_KEY_LOWER_MEDIA_CONTENT_SIZE`].
pub const INDEXED_KEY_UPPER_MEDIA_CONTENT_SIZE: IndexedMediaContentSize =
    js_sys::Number::MAX_SAFE_INTEGER as usize;

/// The earliest [`UnixTime`] which can be represented in IndexedDB.
///
/// This value is useful for constructing a key range over all keys which
/// contain time-related values when used in conjunction with
/// [`INDEXED_KEY_UPPER_UNIX_TIME`].
pub const INDEXED_KEY_LOWER_UNIX_TIME: UnixTime =
    UnixTime::BeforeEpoch(INDEXED_KEY_UPPER_DURATION_SECONDS);

/// The latest [`UnixTime`] which can be represented in IndexedDB.
///
/// This value is useful for constructing a key range over all keys which
/// contain time-related values when used in conjunction with
/// [`INDEXED_KEY_LOWER_UNIX_TIME`].
pub const INDEXED_KEY_UPPER_UNIX_TIME: UnixTime =
    UnixTime::AfterEpoch(INDEXED_KEY_UPPER_DURATION_SECONDS);

/// The minimum value for an [`IndexedMediaContentId`] - i.e.,
/// [`INDEXED_KEY_LOWER_UUID`].
///
/// This value is useful for constructing a key range over all keys which
/// contain [`IndexedMediaContentId`] values when used in conjunction with
/// [`INDEXED_KEY_UPPER_MEDIA_CONTENT_ID`].
pub const INDEXED_KEY_LOWER_MEDIA_CONTENT_ID: IndexedMediaContentId = INDEXED_KEY_LOWER_UUID;

/// The maximum value for an [`IndexedMediaContentId`] - i.e.,
/// [`INDEXED_KEY_UPPER_UUID`].
///
/// This value is useful for constructing a key range over all keys which
/// contain [`IndexedMediaContentId`] values when used in conjunction with
/// [`INDEXED_KEY_LOWER_MEDIA_CONTENT_ID`].
pub const INDEXED_KEY_UPPER_MEDIA_CONTENT_ID: IndexedMediaContentId = INDEXED_KEY_UPPER_UUID;