Skip to content

Commit

Permalink
Add docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
mdrakiburrahman committed Oct 6, 2024
1 parent cd31c37 commit d0ca4b4
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions src/DeltaLake/Kernel/State/EngineContext.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,44 @@ namespace DeltaLake.Kernel.State
/// </summary>
internal struct EngineContext
{
/// <summary>
/// The global table scan state represents progress during a table scan
/// shared from the Kernel to us.
/// </summary>
internal unsafe SharedGlobalScanState* GlobalScanState;

/// <summary>
/// The schema represents the read schema of the table shared from the
/// Kernel to us.
/// </summary>
internal unsafe SharedSchema* Schema;

/// <summary>
/// A pointer to the root of the table.
/// </summary>
internal unsafe char* TableRoot;

/// <summary>
/// The External Engine represents the external engine (us) we share
/// with the Kernel for various callbacks.
/// </summary>
internal unsafe SharedExternEngine* Engine;

/// <summary>
/// Kernel reported list of partitions this Delta Table has.
/// </summary>
internal unsafe PartitionList* PartitionList;

/// <summary>
/// Kernel reported list of values in a partition this Delta Table has.
/// </summary>
internal unsafe CStringMap* PartitionValues;

/// <summary>
/// The ArrowContext holds all state pointers as we load the table from
/// Parquet throughout the scan, this is used to expose the actual data
/// back to end-users by converting from Arrow to various APIs.
/// </summary>
internal unsafe ArrowContext* ArrowContext;

Check warning on line 59 in src/DeltaLake/Kernel/State/EngineContext.cs

View workflow job for this annotation

GitHub Actions / build-lint-test (macos-latest)

This takes the address of, gets the size of, or declares a pointer to a managed type ('ArrowContext')
}
}

0 comments on commit d0ca4b4

Please sign in to comment.