iceoryx2 0.9.0

iceoryx2: Lock-Free Zero-Copy Interprocess Communication
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

// Copyright (c) 2025 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

use serde::{Deserialize, Serialize, de::Visitor};

/// Defines the strategy a sender shall pursue when the buffer of the receiver is full
/// and the service does not overflow.
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub enum BackpressureStrategy {
    /// Retries until the receiver has consumed some
    /// data from the full buffer and there is space again
    RetryUntilDelivered,
    /// Do not deliver the data to receiver with a full buffer
    DiscardData,
}

impl Serialize for BackpressureStrategy {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_str(&alloc::format!("{self:?}"))
    }
}

struct BackpressureStrategyVisitor;

impl Visitor<'_> for BackpressureStrategyVisitor {
    type Value = BackpressureStrategy;

    fn expecting(&self, formatter: &mut core::fmt::Formatter) -> core::fmt::Result {
        formatter.write_str("a string containing either 'RetryUntilDelivered' or 'DiscardData'")
    }

    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
    where
        E: serde::de::Error,
    {
        match v {
            "DiscardData" => Ok(BackpressureStrategy::DiscardData),
            "RetryUntilDelivered" => Ok(BackpressureStrategy::RetryUntilDelivered),
            v => Err(E::custom(alloc::format!(
                "Invalid BackpressureStrategy provided: \"{v:?}\"."
            ))),
        }
    }
}

impl<'de> Deserialize<'de> for BackpressureStrategy {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        deserializer.deserialize_str(BackpressureStrategyVisitor)
    }
}