doc.go 1.1 KB

12345678910111213141516171819202122
  1. // This package provides utilities for efficiently performing Win32 IO operations in Go.
  2. // Currently, this package is provides support for genreal IO and management of
  3. // - named pipes
  4. // - files
  5. // - [Hyper-V sockets]
  6. //
  7. // This code is similar to Go's [net] package, and uses IO completion ports to avoid
  8. // blocking IO on system threads, allowing Go to reuse the thread to schedule other goroutines.
  9. //
  10. // This limits support to Windows Vista and newer operating systems.
  11. //
  12. // Additionally, this package provides support for:
  13. // - creating and managing GUIDs
  14. // - writing to [ETW]
  15. // - opening and manageing VHDs
  16. // - parsing [Windows Image files]
  17. // - auto-generating Win32 API code
  18. //
  19. // [Hyper-V sockets]: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/user-guide/make-integration-service
  20. // [ETW]: https://docs.microsoft.com/en-us/windows-hardware/drivers/devtest/event-tracing-for-windows--etw-
  21. // [Windows Image files]: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/work-with-windows-images
  22. package winio