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

Introduce strum and strum_macros #19

Merged
merged 3 commits into from
Apr 4, 2024
Merged

Introduce strum and strum_macros #19

merged 3 commits into from
Apr 4, 2024

Conversation

jpburnett
Copy link
Contributor

  • This commit introduces the usage of the strum and strum_macros crates. The purpose of these crates is to enable the usage of getting the variant counts and an iterator for the enumeration.

  • Some documentation was added for enums and their functions.

  • Added a basic README.md

  • Bumped versions in Cargo.toml

…ates. The purpose of these crates is to enable the usage of getting the variant counts and an iterator for the enumeration.

Some documentation was added for enums and their functions.

Added a basic README.md

Bumped versions in Cargo.toml
Copy link
Member

@ethteck ethteck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nish! I don't think the count or iter functions are needed though. Clients can just do what they're doing

README.md Outdated Show resolved Hide resolved
This commit removes the implemented functions. Also updates the README.md description.
Copy link
Contributor

@AngheloAlf AngheloAlf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some thoughts

@@ -0,0 +1,6 @@
# pigment64
pigment64 is a library written in Rust for converting image data between native and png formats.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"native" to who? I know it is meant to be as native to the n64, but I don't know if we want to restrict ourselves to only the n64

Comment on lines +32 to 35
/// # Panics
///
/// This method will panic if the image size is invalid.
pub fn get_tlut_size(&self) -> usize {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if in the future we should change this to an Option or a Result instead of panicking. Out of scope for this PR, just writing down my thoughts

Didn't have auto-formatting on, this commit should fix that.
@ethteck ethteck merged commit ff903f0 into decompals:main Apr 4, 2024
4 checks passed
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.

3 participants