couchbase 1.0.1

The official Couchbase Rust 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

/*
 *
 *  * Copyright (c) 2025 Couchbase, 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.
 *
 */

//! Raw string transcoding — stores and retrieves UTF-8 strings with string common flags.

use crate::transcoding::{decode_common_flags, encode_common_flags, DataType};

/// Encodes a UTF-8 string with string common flags.
pub fn encode(value: &str) -> crate::error::Result<(&[u8], u32)> {
    Ok((value.as_bytes(), encode_common_flags(DataType::String)))
}

/// Decodes bytes into a UTF-8 string, verifying the common flags indicate string.
pub fn decode(value: &[u8], flags: u32) -> crate::error::Result<&str> {
    let datatype = decode_common_flags(flags);
    if datatype != DataType::String {
        return Err(crate::error::Error::other_failure("datatype not supported"));
    }

    str::from_utf8(value)
        .map_err(|e| crate::error::Error::other_failure(format!("invalid UTF-8: {e}")))
}