yara-x-capi 1.17.0

A C API for the YARA-X library.
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

use std::ffi::c_char;

/// Types of metadata values.
#[repr(C)]
#[allow(missing_docs)]
pub enum YRX_METADATA_TYPE {
    YRX_I64,
    YRX_F64,
    YRX_BOOLEAN,
    YRX_STRING,
    YRX_BYTES,
}

/// Represents a metadata value that contains raw bytes.
#[derive(Copy, Clone)]
#[repr(C)]
pub struct YRX_METADATA_BYTES {
    /// Number of bytes.
    pub length: usize,
    /// Pointer to the bytes.
    pub data: *const u8,
}

/// A metadata value.
#[repr(C)]
pub union YRX_METADATA_VALUE {
    /// Value if the metadata is I64.
    pub r#i64: i64,
    /// Value if the metadata is F64.
    pub r#f64: f64,
    /// Value if the metadata is BOOLEAN.
    pub boolean: bool,
    /// Value if the metadata is STRING.
    pub string: *const c_char,
    /// Value if the metadata is BYTES.
    pub bytes: YRX_METADATA_BYTES,
}

/// A metadata entry.
#[repr(C)]
pub struct YRX_METADATA {
    /// Metadata identifier.
    pub identifier: *const c_char,
    /// Metadata type.
    pub value_type: YRX_METADATA_TYPE,
    /// Metadata value.
    ///
    /// This a union type, the variant that should be used is determined by the
    /// type indicated in `value_type`.
    pub value: YRX_METADATA_VALUE,
}