Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add: struct BytesView, trait ByteView & binary representation methods. #347

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

shamiao
Copy link

@shamiao shamiao commented Apr 29, 2024

This is a direct port of practice-tested loneoutpost/core-extra/representation mooncake.

Contents

This PR includes 3 main parts

  • Abstractions trait ByteView & trait ByteMutView to indicate Byte sequences from any data source, read-only or writable.
  • Concrete type struct BytesView which indicates a read-and-writable Byte sequence sliced from a Bytes.
  • Binary representations of Int, Int64 and Double supporting any specified endianness.

Solid and complete tests and documentations provided.

Competing PRs

This PR is competing to #328 and #329.

Concrete struct BytesView...

is similar but different from #328. This PR makes the output type Byte instead of Int.

Abstractions trait ByteView & trait ByteMutView

... are new. Since Byte sequence can come from various sources (memory, disk, network...), I think adding such abstractions to core is critical for supporting various programs.

The whole @mem module_ appeared in #329

... which includes abstractions Loadable(read from bytes) or Storable(write into bytes) and implementations for primitive types, are removed.

This PR made these R/W operations (between primitive types and Byte views) simple methods in the primitive types' package, for the following reasons:

  1. Loadable/Storable is actually an abstraction of serialization/deserialization(serde). As the practices from Rust community, serde is more appropriate to appear as a 3rd party package instead of a core feature.
  2. Additionally, endianness conversions are not always considered enough to be a serde operation. It's called binary representation more often.
  3. We cannot assume source and target of serde operations is memory. Binary representation operations may bypass memory entirely. @mem is more suggested to be reserved for usages dealing with real memory.

Notes

This PR somewhats implements #341.

Copy link
Contributor

coderabbitai bot commented Apr 29, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@shamiao
Copy link
Author

shamiao commented Apr 29, 2024

note: actions check/cla-check failure might be a bug:

I think check/cla-check action should verify emails appeared in git log history, instead of primary email of github user?

note: I have changed by primary email to CLA email, good to check again at any time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant