Andy Grove created ARROW-10976:
----------------------------------

             Summary: [Rust] Document use of unsafe in buffer.rs
                 Key: ARROW-10976
                 URL: https://issues.apache.org/jira/browse/ARROW-10976
             Project: Apache Arrow
          Issue Type: Sub-task
          Components: Rust
            Reporter: Andy Grove
             Fix For: 3.0.0


There are ~32 uses of unsafe in buffer.rs and we should document them according 
to the guidelines in the Arrow crate README

 
{code:java}
// JUSTIFICATION
//  Benefit
//      Describe the benefit of using unsafe. E.g.
//      "30% performance degradation if the safe counterpart is used, see bench 
X."
//  Soundness
//      Describe why the code remains sound (according to the definition of 
rust's unsafe code guidelines). E.g.
//      "We bounded check these values at initialization and the array is 
immutable."
let ... = unsafe { ... }; {code}



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to