[jira] [Updated] (ARROW-10981) [Rust] Document use of unsafe in remaining files

["Andy Grove (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/ARROW-10981?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Andy Grove updated ARROW-10981:
-------------------------------
    Description: 
There are ~11 uses of unsafe in the following files and we should document them according to the guidelines in the Arrow crate README
{code:java}
 ./arrow/src/bytes.rs:5
 ./arrow/src/arch/avx512.rs:4
 ./arrow/src/bitmap.rs:1
 ./arrow/src/zz_memory_check.rs:1 {code}
{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}
 

  was:
./arrow/src/bytes.rs:5
./arrow/src/arch/avx512.rs:4
./arrow/src/bitmap.rs:1
./arrow/src/zz_memory_check.rs:1


> [Rust] Document use of unsafe in remaining files
> ------------------------------------------------
>
>                 Key: ARROW-10981
>                 URL: https://issues.apache.org/jira/browse/ARROW-10981
>             Project: Apache Arrow
>          Issue Type: Sub-task
>          Components: Rust
>            Reporter: Andy Grove
>            Priority: Major
>             Fix For: 3.0.0
>
>
> There are ~11 uses of unsafe in the following files and we should document them according to the guidelines in the Arrow crate README
> {code:java}
>  ./arrow/src/bytes.rs:5
>  ./arrow/src/arch/avx512.rs:4
>  ./arrow/src/bitmap.rs:1
>  ./arrow/src/zz_memory_check.rs:1 {code}
> {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)