Skip to content

Commit 4629c10

Browse files
authored
Public api lockfiles (#6348)
This should help us work towards reducing our public API surface and track changes. To re-generate, run `./scripts/public-api.sh` It's not super fast... so it might be a bit annoying until the API stabilizes. --------- Signed-off-by: Nicholas Gates <nick@nickgates.com>
1 parent 7c26470 commit 4629c10

35 files changed

Lines changed: 17488 additions & 1 deletion

File tree

.github/workflows/ci.yml

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,35 @@ jobs:
323323
run: |
324324
cargo hack --no-dev-deps --ignore-private clippy --no-default-features -- -D warnings
325325
326-
rust-coverage:
326+
public-api:
327+
name: "Public API lock files"
328+
timeout-minutes: 120
329+
runs-on:
330+
- runs-on=${{ github.run_id }}
331+
- family=m7i+m7i-flex+m7a
332+
- cpu=16
333+
- image=ubuntu24-full-x64
334+
- extras=s3-cache
335+
- tag=public-api
336+
steps:
337+
- uses: runs-on/action@v2
338+
with:
339+
sccache: s3
340+
- uses: actions/checkout@v6
341+
- uses: ./.github/actions/setup-rust
342+
with:
343+
repo-token: ${{ secrets.GITHUB_TOKEN }}
344+
toolchain: nightly
345+
- name: Install cargo-public-api
346+
run: cargo install cargo-public-api --locked
347+
- name: Regenerate public API lock files
348+
run: bash scripts/public-api.sh
349+
- name: Verify lock files are up to date
350+
run: |
351+
git diff --name-only
352+
git diff --exit-code '**/public-api.lock'
353+
354+
ust-coverage:
327355
name: "Rust tests (coverage) (${{ matrix.suite }})"
328356
timeout-minutes: 120
329357
permissions:

encodings/alp/public-api.lock

Lines changed: 249 additions & 0 deletions
Large diffs are not rendered by default.

encodings/bytebool/public-api.lock

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
pub mod vortex_bytebool
2+
pub struct vortex_bytebool::ByteBoolArray
3+
impl vortex_bytebool::ByteBoolArray
4+
pub fn vortex_bytebool::ByteBoolArray::as_slice(&self) -> &[bool]
5+
pub fn vortex_bytebool::ByteBoolArray::buffer(&self) -> &vortex_array::buffer::BufferHandle
6+
pub fn vortex_bytebool::ByteBoolArray::from_vec<V: core::convert::Into<vortex_array::validity::Validity>>(data: alloc::vec::Vec<bool>, validity: V) -> Self
7+
pub fn vortex_bytebool::ByteBoolArray::new(buffer: vortex_array::buffer::BufferHandle, validity: vortex_array::validity::Validity) -> Self
8+
impl core::clone::Clone for vortex_bytebool::ByteBoolArray
9+
pub fn vortex_bytebool::ByteBoolArray::clone(&self) -> vortex_bytebool::ByteBoolArray
10+
impl core::convert::AsRef<dyn vortex_array::array::Array> for vortex_bytebool::ByteBoolArray
11+
pub fn vortex_bytebool::ByteBoolArray::as_ref(&self) -> &dyn vortex_array::array::Array
12+
impl core::convert::From<alloc::vec::Vec<bool>> for vortex_bytebool::ByteBoolArray
13+
pub fn vortex_bytebool::ByteBoolArray::from(value: alloc::vec::Vec<bool>) -> Self
14+
impl core::convert::From<alloc::vec::Vec<core::option::Option<bool>>> for vortex_bytebool::ByteBoolArray
15+
pub fn vortex_bytebool::ByteBoolArray::from(value: alloc::vec::Vec<core::option::Option<bool>>) -> Self
16+
impl core::convert::From<vortex_bytebool::ByteBoolArray> for vortex_array::array::ArrayRef
17+
pub fn vortex_array::array::ArrayRef::from(value: vortex_bytebool::ByteBoolArray) -> vortex_array::array::ArrayRef
18+
impl core::fmt::Debug for vortex_bytebool::ByteBoolArray
19+
pub fn vortex_bytebool::ByteBoolArray::fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result
20+
impl core::ops::deref::Deref for vortex_bytebool::ByteBoolArray
21+
pub type vortex_bytebool::ByteBoolArray::Target = dyn vortex_array::array::Array
22+
pub fn vortex_bytebool::ByteBoolArray::deref(&self) -> &Self::Target
23+
impl vortex_array::array::IntoArray for vortex_bytebool::ByteBoolArray
24+
pub fn vortex_bytebool::ByteBoolArray::into_array(self) -> vortex_array::array::ArrayRef
25+
impl vortex_array::vtable::validity::ValidityHelper for vortex_bytebool::ByteBoolArray
26+
pub fn vortex_bytebool::ByteBoolArray::validity(&self) -> &vortex_array::validity::Validity
27+
pub struct vortex_bytebool::ByteBoolVTable
28+
impl vortex_bytebool::ByteBoolVTable
29+
pub const vortex_bytebool::ByteBoolVTable::ID: vortex_array::vtable::dyn_::ArrayId
30+
impl core::fmt::Debug for vortex_bytebool::ByteBoolVTable
31+
pub fn vortex_bytebool::ByteBoolVTable::fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result
32+
impl vortex_array::arrays::dict::take::TakeExecute for vortex_bytebool::ByteBoolVTable
33+
pub fn vortex_bytebool::ByteBoolVTable::take(array: &vortex_bytebool::ByteBoolArray, indices: &dyn vortex_array::array::Array, _ctx: &mut vortex_array::executor::ExecutionCtx) -> vortex_error::VortexResult<core::option::Option<vortex_array::array::ArrayRef>>
34+
impl vortex_array::arrays::slice::SliceReduce for vortex_bytebool::ByteBoolVTable
35+
pub fn vortex_bytebool::ByteBoolVTable::slice(array: &vortex_bytebool::ByteBoolArray, range: core::ops::range::Range<usize>) -> vortex_error::VortexResult<core::option::Option<vortex_array::array::ArrayRef>>
36+
impl vortex_array::compute::cast::CastKernel for vortex_bytebool::ByteBoolVTable
37+
pub fn vortex_bytebool::ByteBoolVTable::cast(&self, array: &vortex_bytebool::ByteBoolArray, dtype: &vortex_dtype::dtype::DType) -> vortex_error::VortexResult<core::option::Option<vortex_array::array::ArrayRef>>
38+
impl vortex_array::compute::mask::MaskKernel for vortex_bytebool::ByteBoolVTable
39+
pub fn vortex_bytebool::ByteBoolVTable::mask(&self, array: &vortex_bytebool::ByteBoolArray, mask: &vortex_mask::Mask) -> vortex_error::VortexResult<vortex_array::array::ArrayRef>
40+
impl vortex_array::vtable::VTable for vortex_bytebool::ByteBoolVTable
41+
pub type vortex_bytebool::ByteBoolVTable::Array = vortex_bytebool::ByteBoolArray
42+
pub type vortex_bytebool::ByteBoolVTable::ArrayVTable = vortex_bytebool::ByteBoolVTable
43+
pub type vortex_bytebool::ByteBoolVTable::Metadata = vortex_array::metadata::EmptyMetadata
44+
pub type vortex_bytebool::ByteBoolVTable::OperationsVTable = vortex_bytebool::ByteBoolVTable
45+
pub type vortex_bytebool::ByteBoolVTable::ValidityVTable = vortex_array::vtable::validity::ValidityVTableFromValidityHelper
46+
pub type vortex_bytebool::ByteBoolVTable::VisitorVTable = vortex_bytebool::ByteBoolVTable
47+
pub fn vortex_bytebool::ByteBoolVTable::build(dtype: &vortex_dtype::dtype::DType, len: usize, _metadata: &Self::Metadata, buffers: &[vortex_array::buffer::BufferHandle], children: &dyn vortex_array::serde::ArrayChildren) -> vortex_error::VortexResult<vortex_bytebool::ByteBoolArray>
48+
pub fn vortex_bytebool::ByteBoolVTable::deserialize(_bytes: &[u8], _dtype: &vortex_dtype::dtype::DType, _len: usize, _session: &vortex_session::VortexSession) -> vortex_error::VortexResult<Self::Metadata>
49+
pub fn vortex_bytebool::ByteBoolVTable::execute(array: &Self::Array, _ctx: &mut vortex_array::executor::ExecutionCtx) -> vortex_error::VortexResult<vortex_array::array::ArrayRef>
50+
pub fn vortex_bytebool::ByteBoolVTable::execute_parent(array: &Self::Array, parent: &vortex_array::array::ArrayRef, child_idx: usize, ctx: &mut vortex_array::executor::ExecutionCtx) -> vortex_error::VortexResult<core::option::Option<vortex_array::array::ArrayRef>>
51+
pub fn vortex_bytebool::ByteBoolVTable::id(_array: &Self::Array) -> vortex_array::vtable::dyn_::ArrayId
52+
pub fn vortex_bytebool::ByteBoolVTable::metadata(_array: &vortex_bytebool::ByteBoolArray) -> vortex_error::VortexResult<Self::Metadata>
53+
pub fn vortex_bytebool::ByteBoolVTable::reduce_parent(array: &Self::Array, parent: &vortex_array::array::ArrayRef, child_idx: usize) -> vortex_error::VortexResult<core::option::Option<vortex_array::array::ArrayRef>>
54+
pub fn vortex_bytebool::ByteBoolVTable::serialize(_metadata: Self::Metadata) -> vortex_error::VortexResult<core::option::Option<alloc::vec::Vec<u8>>>
55+
pub fn vortex_bytebool::ByteBoolVTable::with_children(array: &mut Self::Array, children: alloc::vec::Vec<vortex_array::array::ArrayRef>) -> vortex_error::VortexResult<()>
56+
impl vortex_array::vtable::array::BaseArrayVTable<vortex_bytebool::ByteBoolVTable> for vortex_bytebool::ByteBoolVTable
57+
pub fn vortex_bytebool::ByteBoolVTable::array_eq(array: &vortex_bytebool::ByteBoolArray, other: &vortex_bytebool::ByteBoolArray, precision: vortex_array::hash::Precision) -> bool
58+
pub fn vortex_bytebool::ByteBoolVTable::array_hash<H: core::hash::Hasher>(array: &vortex_bytebool::ByteBoolArray, state: &mut H, precision: vortex_array::hash::Precision)
59+
pub fn vortex_bytebool::ByteBoolVTable::dtype(array: &vortex_bytebool::ByteBoolArray) -> &vortex_dtype::dtype::DType
60+
pub fn vortex_bytebool::ByteBoolVTable::len(array: &vortex_bytebool::ByteBoolArray) -> usize
61+
pub fn vortex_bytebool::ByteBoolVTable::stats(array: &vortex_bytebool::ByteBoolArray) -> vortex_array::stats::array::StatsSetRef<'_>
62+
impl vortex_array::vtable::operations::OperationsVTable<vortex_bytebool::ByteBoolVTable> for vortex_bytebool::ByteBoolVTable
63+
pub fn vortex_bytebool::ByteBoolVTable::scalar_at(array: &vortex_bytebool::ByteBoolArray, index: usize) -> vortex_error::VortexResult<vortex_scalar::scalar::Scalar>
64+
impl vortex_array::vtable::visitor::VisitorVTable<vortex_bytebool::ByteBoolVTable> for vortex_bytebool::ByteBoolVTable
65+
pub fn vortex_bytebool::ByteBoolVTable::nbuffers(_array: &vortex_bytebool::ByteBoolArray) -> usize
66+
pub fn vortex_bytebool::ByteBoolVTable::nchildren(array: &vortex_bytebool::ByteBoolArray) -> usize
67+
pub fn vortex_bytebool::ByteBoolVTable::visit_buffers(array: &vortex_bytebool::ByteBoolArray, visitor: &mut dyn vortex_array::array::visitor::ArrayBufferVisitor)
68+
pub fn vortex_bytebool::ByteBoolVTable::visit_children(array: &vortex_bytebool::ByteBoolArray, visitor: &mut dyn vortex_array::array::visitor::ArrayChildVisitor)

0 commit comments

Comments
 (0)