Trait Action

Source

pub trait Action {
    const ACTION: &'static str;

    // Provided methods
    fn to_json_slice<'buf>(
        &self,
        buf: &'buf mut [u8],
    ) -> Result<&'buf [u8], Error>
       where Self: Serialize { ... }
    fn to_json_str<'buf>(&self, buf: &'buf mut [u8]) -> Result<&'buf str, Error>
       where Self: Serialize { ... }
    fn from_json_slice(data: &[u8]) -> Result<Self, Error>
       where Self: Sized + DeserializeOwned { ... }
    fn from_json_str(data: &str) -> Result<Self, Error>
       where Self: Sized + DeserializeOwned { ... }
}

Required Associated Constants§

Source

const ACTION: &'static str

Provided Methods§

Source

fn to_json_slice<'buf>(&self, buf: &'buf mut [u8]) -> Result<&'buf [u8], Error>
where Self: Serialize,

Serializes this message as JSON into buf, returning the written slice. No allocation: the caller owns and sizes the buffer, same as every other bounded type in this crate.

Examples found in repository ?

examples/serialization.rs (line 25)

8fn main() {
9    let request = AuthorizeRequest {
10        id_tag: IdTag::try_from("ABC123").expect("fits in 20 chars"),
11    };
12
13    // The caller owns the buffer -- nothing here allocates.
14    let mut buf = [0u8; 256];
15    let json: &str = request.to_json_str(&mut buf).expect("buffer is big enough");
16    println!("serialized: {json}");
17
18    let parsed = AuthorizeRequest::from_json_str(json).expect("valid JSON");
19    assert_eq!(parsed, request);
20    println!("round-tripped successfully: {parsed:?}");
21
22    // `to_json_slice`/`from_json_slice` are the same, but for raw bytes
23    // instead of `&str`.
24    let mut byte_buf = [0u8; 256];
25    let bytes: &[u8] = request.to_json_slice(&mut byte_buf).unwrap();
26    println!("as bytes: {bytes:?}");
27}

Source

fn to_json_str<'buf>(&self, buf: &'buf mut [u8]) -> Result<&'buf str, Error>
where Self: Serialize,

Same as Action::to_json_slice, but returns the written bytes as &str. JSON emitted by serde-json-core is always valid UTF-8.

Examples found in repository ?

examples/serialization.rs (line 15)

8fn main() {
9    let request = AuthorizeRequest {
10        id_tag: IdTag::try_from("ABC123").expect("fits in 20 chars"),
11    };
12
13    // The caller owns the buffer -- nothing here allocates.
14    let mut buf = [0u8; 256];
15    let json: &str = request.to_json_str(&mut buf).expect("buffer is big enough");
16    println!("serialized: {json}");
17
18    let parsed = AuthorizeRequest::from_json_str(json).expect("valid JSON");
19    assert_eq!(parsed, request);
20    println!("round-tripped successfully: {parsed:?}");
21
22    // `to_json_slice`/`from_json_slice` are the same, but for raw bytes
23    // instead of `&str`.
24    let mut byte_buf = [0u8; 256];
25    let bytes: &[u8] = request.to_json_slice(&mut byte_buf).unwrap();
26    println!("as bytes: {bytes:?}");
27}

Source

fn from_json_slice(data: &[u8]) -> Result<Self, Error>
where Self: Sized + DeserializeOwned,

Deserializes this message from JSON bytes. No allocation: parsing borrows from data only transiently: Self owns everything via heapless collections, so nothing outlives this call.

Source

fn from_json_str(data: &str) -> Result<Self, Error>
where Self: Sized + DeserializeOwned,

Same as Action::from_json_slice, but takes a &str instead of raw bytes (skipping the UTF-8 check from_json_slice would otherwise need, since &str already guarantees it).

Examples found in repository ?

examples/serialization.rs (line 18)

8fn main() {
9    let request = AuthorizeRequest {
10        id_tag: IdTag::try_from("ABC123").expect("fits in 20 chars"),
11    };
12
13    // The caller owns the buffer -- nothing here allocates.
14    let mut buf = [0u8; 256];
15    let json: &str = request.to_json_str(&mut buf).expect("buffer is big enough");
16    println!("serialized: {json}");
17
18    let parsed = AuthorizeRequest::from_json_str(json).expect("valid JSON");
19    assert_eq!(parsed, request);
20    println!("round-tripped successfully: {parsed:?}");
21
22    // `to_json_slice`/`from_json_slice` are the same, but for raw bytes
23    // instead of `&str`.
24    let mut byte_buf = [0u8; 256];
25    let bytes: &[u8] = request.to_json_slice(&mut byte_buf).unwrap();
26    println!("as bytes: {bytes:?}");
27}

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Trait Action Copy item path

Required Associated Constants§

const ACTION: &'static str

Provided Methods§

fn to_json_slice<'buf>(&self, buf: &'buf mut [u8]) -> Result<&'buf [u8], Error>where Self: Serialize,

fn to_json_str<'buf>(&self, buf: &'buf mut [u8]) -> Result<&'buf str, Error>where Self: Serialize,

fn from_json_slice(data: &[u8]) -> Result<Self, Error>where Self: Sized + DeserializeOwned,

fn from_json_str(data: &str) -> Result<Self, Error>where Self: Sized + DeserializeOwned,

Dyn Compatibility§

Implementors§

impl Action for ocpp_types::v16::AuthorizeRequest

const ACTION: &'static str = "Authorize"

impl Action for ocpp_types::v16::AuthorizeResponse

const ACTION: &'static str = "Authorize"

impl Action for ocpp_types::v16::BootNotificationRequest

const ACTION: &'static str = "BootNotification"

impl Action for ocpp_types::v16::BootNotificationResponse

const ACTION: &'static str = "BootNotification"

impl Action for ocpp_types::v16::CancelReservationRequest

const ACTION: &'static str = "CancelReservation"

impl Action for ocpp_types::v16::CancelReservationResponse

const ACTION: &'static str = "CancelReservation"

impl Action for ocpp_types::v16::CertificateSignedRequest

const ACTION: &'static str = "CertificateSigned"

impl Action for ocpp_types::v16::CertificateSignedResponse

const ACTION: &'static str = "CertificateSigned"

impl Action for ocpp_types::v16::ChangeAvailabilityRequest

const ACTION: &'static str = "ChangeAvailability"

impl Action for ocpp_types::v16::ChangeAvailabilityResponse

const ACTION: &'static str = "ChangeAvailability"

impl Action for ChangeConfigurationRequest

const ACTION: &'static str = "ChangeConfiguration"

impl Action for ChangeConfigurationResponse

const ACTION: &'static str = "ChangeConfiguration"

impl Action for ocpp_types::v16::ClearCacheRequest

const ACTION: &'static str = "ClearCache"

impl Action for ocpp_types::v16::ClearCacheResponse

const ACTION: &'static str = "ClearCache"

impl Action for ocpp_types::v16::ClearChargingProfileRequest

const ACTION: &'static str = "ClearChargingProfile"

impl Action for ocpp_types::v16::ClearChargingProfileResponse

const ACTION: &'static str = "ClearChargingProfile"

impl Action for ocpp_types::v16::DataTransferRequest

const ACTION: &'static str = "DataTransfer"

impl Action for ocpp_types::v16::DataTransferResponse

const ACTION: &'static str = "DataTransfer"

impl Action for ocpp_types::v16::DeleteCertificateRequest

const ACTION: &'static str = "DeleteCertificate"

impl Action for ocpp_types::v16::DeleteCertificateResponse

const ACTION: &'static str = "DeleteCertificate"

impl Action for DiagnosticsStatusNotificationRequest

const ACTION: &'static str = "DiagnosticsStatusNotification"

impl Action for DiagnosticsStatusNotificationResponse

const ACTION: &'static str = "DiagnosticsStatusNotification"

impl Action for ExtendedTriggerMessageRequest

const ACTION: &'static str = "ExtendedTriggerMessage"

impl Action for ExtendedTriggerMessageResponse

const ACTION: &'static str = "ExtendedTriggerMessage"

impl Action for ocpp_types::v16::FirmwareStatusNotificationRequest

const ACTION: &'static str = "FirmwareStatusNotification"

impl Action for ocpp_types::v16::FirmwareStatusNotificationResponse

const ACTION: &'static str = "FirmwareStatusNotification"

impl Action for ocpp_types::v16::GetCompositeScheduleRequest

const ACTION: &'static str = "GetCompositeSchedule"

impl Action for ocpp_types::v16::GetCompositeScheduleResponse

const ACTION: &'static str = "GetCompositeSchedule"

impl Action for GetConfigurationRequest

const ACTION: &'static str = "GetConfiguration"

impl Action for GetConfigurationResponse

const ACTION: &'static str = "GetConfiguration"

impl Action for GetDiagnosticsRequest

const ACTION: &'static str = "GetDiagnostics"

impl Action for GetDiagnosticsResponse

const ACTION: &'static str = "GetDiagnostics"

impl Action for ocpp_types::v16::GetInstalledCertificateIdsRequest

const ACTION: &'static str = "GetInstalledCertificateIds"

impl Action for ocpp_types::v16::GetInstalledCertificateIdsResponse

const ACTION: &'static str = "GetInstalledCertificateIds"

impl Action for ocpp_types::v16::GetLocalListVersionRequest

const ACTION: &'static str = "GetLocalListVersion"

Trait Action

fn to_json_slice<'buf>(&self, buf: &'buf mut [u8]) -> Result<&'buf [u8], Error>
where Self: Serialize,

fn to_json_str<'buf>(&self, buf: &'buf mut [u8]) -> Result<&'buf str, Error>
where Self: Serialize,

fn from_json_slice(data: &[u8]) -> Result<Self, Error>
where Self: Sized + DeserializeOwned,

fn from_json_str(data: &str) -> Result<Self, Error>
where Self: Sized + DeserializeOwned,