Git Product home page Git Product logo

Comments (4)

frol avatar frol commented on July 18, 2024

@Fuuzetsu Does serde support it? I feel it is a rare case and users may just implement an internal helper struct for serializing/deserializing (kind of like this)

from borsh-rs.

Fuuzetsu avatar Fuuzetsu commented on July 18, 2024

@Fuuzetsu Does serde support it? I feel it is a rare case and users may just implement an internal helper struct for serializing/deserializing (kind of like this)

Seems to work out of the box in serde for this example: https://play.rust-lang.org/?version=nightly&mode=debug&edition=2021&gist=2005b735ca5ca80559abf53f03b36475

from borsh-rs.

dj8yfo avatar dj8yfo commented on July 18, 2024

serde achieves #[repr(packed)] partially working by surrounding (all) referenced fields with brackets { ... }, which somewhat implicitly copies the field's value.

(it would be borsh::BorshSerialize::serialize(&{self.0}, writer)?; in borsh-s case

It works fine for Copy fields:

#[derive(serde::Serialize)]
#[repr(packed)]
struct Bar {
    x: u8,
    y: u64,
}

and is a compilation error for non-Copy types:

#[derive(serde::Serialize)]
#[repr(packed)]
struct Foo {
    x: RefCell<u8>,
    y: u64,
}
 1  error[E0507]: cannot move out of `self.x` which is behind a shared reference
   --> src/main.rs:12:10
    |
 12 | #[derive(serde::Serialize)]
    |          ^^^^^^^^^^^^^^^^ move occurs because `self.x` has type `RefCell<u8>`, which does not implement the `Copy` trait
    |
    = note: `#[derive(serde::Serialize)]` triggers a move because taking references to the fields of a packed struct is undefined behaviour
    = note: this error originates in the derive macro `serde::Serialize` (in Nightly builds, run with -Z macro-backtrace for more info)

imo replicating serde-s behaviour with packed structs is worse than letting a user transparently work with unaligned references.

from borsh-rs.

dj8yfo avatar dj8yfo commented on July 18, 2024

a more versatile template for derives, allowing to work with non-Copy types, might look like the following:

use core::mem;
use core::ops::Deref;
use core::ptr;
use std::rc::Rc;

#[repr(packed)]
struct Foo {
    x: Rc<u8>,
    y: u64,
}

impl borsh::ser::BorshSerialize for Foo {
    fn serialize<W: borsh::io::Write>(
        &self,
        writer: &mut W,
    ) -> ::core::result::Result<(), borsh::io::Error> {
        borsh::BorshSerialize::serialize(
            mem::ManuallyDrop::new(unsafe { ptr::read_unaligned(ptr::addr_of!(self.x)) }).deref(),
            writer,
        )?;
        borsh::BorshSerialize::serialize(
            mem::ManuallyDrop::new(unsafe { ptr::read_unaligned(ptr::addr_of!(self.y)) }).deref(),
            writer,
        )?;
        Ok(())
    }
}

fn main() {
    let foo = Foo {
        x: Rc::new(42),
        y: 182,
    };
    println!("{:?}", borsh::to_vec(&foo).unwrap());
}

from borsh-rs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.