Skip to content

Use record struct in FileHeaderOffset #1161

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.

Sign up for GitHub

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

Merged
BobLd merged 1 commit into from
Sep 20, 2025
Merged

Use record struct in FileHeaderOffset #1161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions src/UglyToad.PdfPig/Parser/FileStructure/FileHeaderOffset.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
/// How many bytes precede the "%PDF-" version header in the file. In some files this 'junk' can
/// offset all following offset bytes.
/// </summary>
internal readonly struct FileHeaderOffset(int value)
internal readonly record struct FileHeaderOffset(int Value) : IEquatable<FileHeaderOffset>
{
public int Value => value;
public override string ToString() => Value.ToString();

public bool Equals(FileHeaderOffset other)
{
return Value == other.Value;
}

public override string ToString() => value.ToString();

public override bool Equals(object? obj) =>
obj is FileHeaderOffset other && value == other.Value;

public override int GetHashCode() => value.GetHashCode();
public override int GetHashCode() => Value.GetHashCode();
Copy link
Member

@EliotJones EliotJones Sep 15, 2025

Choose a reason for hiding this comment

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

Don't record structs provide these default implementations already?

Copy link

@cremor cremor Sep 16, 2025

Choose a reason for hiding this comment

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

Yes, including the IEquatable implementation. See .NET Lab

Copy link
Collaborator Author

@BobLd BobLd Sep 16, 2025

Choose a reason for hiding this comment

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

They do, but with default implementation. It's seems to be more efficient for speed to provide it when possible. Ill provide the source of that shortly

Copy link
Collaborator Author

@BobLd BobLd Sep 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

not implementing these means it's going to use the EqualityComparer<int>.Default

See https://lab.razor.fyi/#pZHBSgMxEIZRLGhO4hPMsb3kAVxbkKptRVDo4sGTaXa6DWaTdiYrFOnDeBUPevXNvEl2D66lFcScMv_8f75JIt5aQtyQz0kVUvPRc6tk43IYLzlgkYhmJfveWtTBeMdygA7J6F8co6Iog5pYXPOcGZU7z8Fo3t6RfZ_hqVN2yWbddmXcYk1KZ4QqMy7fpstU8QMnQhgXkJyyEBve2SUQak8ZcKBSB7gwFoeoMqTr6ZQxtI0LcKtsiR3xJAAA5uXEGg3-EYlMhjEYiakfV5t2B7q9OiG_tUSs_s4eFfMGHo5hdL4oVfWmJxu8vf8NGKPN_MR7CxFoub2BBj7MkDpVoubGRRhKcvXp0O3WJlmVNWElNs4YrznAMFQ8iz_fnPGHnIjV5a7mu4P91_fPj5fp4d79zhc

In this specific case (single int in the struct), it's unsure if it's an actual improvement (might be an overkill).

See here for different benchmarks on record struct https://nietras.com/2021/06/14/csharp-10-record-struct/

}
6 changes: 6 additions & 0 deletions src/UglyToad.PdfPig/Polyfills/IsExternalInitPoly.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#if !NET
namespace System.Runtime.CompilerServices
{
internal static class IsExternalInit { }
}
#endif
Loading