safe_core 0.43.1

SAFE core
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

// Copyright 2018 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.

#![allow(unsafe_code)]

/// Type definitions for arrays that are FFI input params.
pub mod arrays;
/// FFI Error Codes
pub mod error_codes;
/// IPC utilities.
pub mod ipc;
/// NFS API.
pub mod nfs;
use self::arrays::*;
use safe_nd::MDataKind as NativeMDataKind;

/// FFI wrapper for `MDataInfo`.
#[repr(C)]
#[derive(Clone)]
pub struct MDataInfo {
    // NOTE: `repr[C]` enums don't seem to be supported by JNI right now, so we use a bool.
    /// The kind of the mutable data.
    pub seq: bool,
    /// Name of the mutable data.
    pub name: XorNameArray,
    /// Type tag of the mutable data.
    pub type_tag: u64,

    /// Flag indicating whether the encryption info (`enc_key` and `enc_nonce`) is set.
    pub has_enc_info: bool,
    /// Encryption key. Meaningful only if `has_enc_info` is `true`.
    pub enc_key: SymSecretKey,
    /// Encryption nonce. Meaningful only if `has_enc_info` is `true`.
    pub enc_nonce: SymNonce,

    /// Flag indicating whether the new encryption info is set.
    pub has_new_enc_info: bool,
    /// New encryption key (used for two-phase reencryption). Meaningful only if
    /// `has_new_enc_info` is `true`.
    pub new_enc_key: SymSecretKey,
    /// New encryption nonce (used for two-phase reencryption). Meaningful only if
    /// `has_new_enc_info` is `true`.
    pub new_enc_nonce: SymNonce,
}

// TODO: Implement `into_repr_c` for MDataKind once we move FfiMDataKind to safe-nd.
/// Convert from native to FFI representation for `MDataKind`.
pub fn md_kind_into_repr_c(kind: NativeMDataKind) -> bool {
    match kind {
        NativeMDataKind::Seq => true,
        NativeMDataKind::Unseq => false,
    }
}

// TODO: Implement `clone_from_repr_c` for `MDataKind` once we move
// `FfiMDataKind` to safe-nd.
/// Convert from FFI to native representation for `MDataKind`.
pub fn md_kind_clone_from_repr_c(kind: bool) -> NativeMDataKind {
    if kind {
        NativeMDataKind::Seq
    } else {
        NativeMDataKind::Unseq
    }
}