Make NuidWriter public

[Madgvox]

This PR makes the NuidWriter class public, and moves it into the Core namespace out of the Internal namespace.

Resolves #617.

[mtmk]

Thanks @Madgvox. Can I ask you to sign your commit please? It's a CNCF requirement, and we won't be able to merge because of GitHub rules setup for this repo. You will have to force push, which should be fine. Thank you 💯

[Madgvox]

Thanks @Madgvox. Can I ask you to sign your commit please? It's a CNCF requirement, and we won't be able to merge because of GitHub rules setup for this repo. You will have to force push, which should be fine. Thank you 💯

Should be corrected now.

[jasper-d]

I think it would be better change the naming as follows:

- public static class NuidWriter {
+ public static class Nuid { // or NuidGenerator if you prefer
-   public static bool TryWriteNuid(Span<char> nuidBuffer);
+   public static int Write(Span<char> destination); // Throw for inappropriate sized destination, return number of chars written
}

Reasoning:

1. Having GetString() on a type that is call "writer" seems a bit odd, calling the type Nuid or NuidGenerator avoids that issue.
2. TryWriteNuid does not provide information how many chars are written, this is internal knowledge of the implementation.
3. NuidWriter.TryWriteNuid duplicates notions of "nuid" and "write" unnecessarily
4. I would expect callers to usually know how large their buffer is, so the try-pattern seems a bit unecessary here.
5. If you want to keep the try-pattern (may possibly provide some perf-benefits with enough inlining and a suitable call-site), I'd propose bool TryWrite(Span<char> destination, out int charsWritten) to align better with other try-APIs in the BCL.
6. Additionally, you may want to expose NuidLength as public static readonly int Length or something, so callers can use it when allocating buffers instead of relying on undocumented implementation details.

[mtmk]

I think it would be better change the naming as follows:

- public static class NuidWriter {
+ public static class Nuid { // or NuidGenerator if you prefer
-   public static bool TryWriteNuid(Span<char> nuidBuffer);
+   public static int Write(Span<char> destination); // Throw for inappropriate sized destination, return number of chars written
}

Reasoning:

1. Having GetString() on a type that is call "writer" seems a bit odd, calling the type Nuid or NuidGenerator avoids that issue.

I'd be happy with either name

2. TryWriteNuid does not provide information how many chars are written, this is internal knowledge of the implementation.
3. NuidWriter.TryWriteNuid duplicates notions of "nuid" and "write" unnecessarily
4. I would expect callers to usually know how large their buffer is, so the try-pattern seems a bit unecessary here.
5. If you want to keep the try-pattern (may possibly provide some perf-benefits with enough inlining and a suitable call-site), I'd propose bool TryWrite(Span<char> destination, out int charsWritten) to align better with other try-APIs in the BCL.

This makes a lot of sense if we want to expose it. @Madgvox would you be using TryWrite?

6. Additionally, you may want to expose NuidLength as public static readonly int Length or something, so callers can use it when allocating buffers instead of relying on undocumented implementation details.

If we want TryWrite it'd be good to expose Length

[Madgvox]

I'd be using the GetString() variant most likely. We use Nuids for dynamic subject IDs.

[mtmk]

Renamed the class to Nuid and made TryWriteNuid internal again. we can open it up if there is need. plus xml docs. @Madgvox @jasper-d let me know if you're happy then I shall merge. thank you 💯

[jasper-d]

Code changes LGTM, did not review workflow changes.

[Madgvox]

LGTM 👍

[mtmk]

LGTM thanks @Madgvox and @jasper-d