byte_sequence.h

Go to the documentation of this file.

// Copyright 2026 The IREE Authors
//
// Licensed under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
#ifndef LOOMC_BYTE_SEQUENCE_H_
#define LOOMC_BYTE_SEQUENCE_H_
 
#include "loomc/base.h"

 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct loomc_byte_sequence_t loomc_byte_sequence_t;

typedef loomc_status_t(LOOMC_API_PTR* loomc_byte_sequence_callback_fn_t)(
    void* user_data, loomc_byte_span_t segment);

typedef struct loomc_byte_sequence_callback_t {
  loomc_byte_sequence_callback_fn_t fn;

  void* user_data;
} loomc_byte_sequence_callback_t;

LOOMC_API_EXPORT loomc_status_t loomc_byte_sequence_create_copy(
    loomc_byte_span_t contents, loomc_allocator_t allocator,
    loomc_byte_sequence_t** out_sequence);

LOOMC_API_EXPORT void loomc_byte_sequence_retain(
    loomc_byte_sequence_t* sequence);

LOOMC_API_EXPORT void loomc_byte_sequence_release(
    loomc_byte_sequence_t* sequence);

LOOMC_API_EXPORT uint64_t
loomc_byte_sequence_length(const loomc_byte_sequence_t* sequence);

LOOMC_API_EXPORT bool loomc_byte_sequence_try_get_contiguous_span(
    const loomc_byte_sequence_t* sequence, loomc_byte_span_t* out_span);

LOOMC_API_EXPORT loomc_status_t
loomc_byte_sequence_enumerate(const loomc_byte_sequence_t* sequence,
                              loomc_byte_sequence_callback_t callback);

LOOMC_API_EXPORT loomc_status_t loomc_byte_sequence_clone(
    const loomc_byte_sequence_t* sequence, loomc_allocator_t allocator,
    loomc_byte_span_t* out_span);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_BYTE_SEQUENCE_H_