{"id":20727618,"url":"https://github.com/cwchentw/overloading-golang","last_synced_at":"2026-05-29T08:04:53.163Z","repository":{"id":77777952,"uuid":"91928679","full_name":"cwchentw/overloading-golang","owner":"cwchentw","description":"Function Overloading in Golang","archived":false,"fork":false,"pushed_at":"2021-10-15T18:35:53.000Z","size":11,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-11T09:27:59.425Z","etag":null,"topics":["function-overloading","golang","golang-package","method-overloading"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cwchentw.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-21T02:37:50.000Z","updated_at":"2021-10-15T18:36:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"5c26b441-0e73-40f0-a5a7-72df1deb2eed","html_url":"https://github.com/cwchentw/overloading-golang","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cwchentw/overloading-golang","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cwchentw%2Foverloading-golang","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cwchentw%2Foverloading-golang/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cwchentw%2Foverloading-golang/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cwchentw%2Foverloading-golang/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cwchentw","download_url":"https://codeload.github.com/cwchentw/overloading-golang/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cwchentw%2Foverloading-golang/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33642325,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-29T02:00:06.066Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["function-overloading","golang","golang-package","method-overloading"],"created_at":"2024-11-17T04:32:51.762Z","updated_at":"2026-05-29T08:04:53.158Z","avatar_url":"https://github.com/cwchentw.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Function Overloading in Go\n\nA lightweight argument checker to simulate function overloading in Golang.\n\n## Introduction\n\nGo does not support function or method overloading. One common workaround is using variadic parameters:\n\n```go\nfunc Foo(args ...interface{}) interface{} {\n    // Process args\n}\n```\n\nWhile flexible, this approach sacrifices type safety and often leads to repetitive, error-prone argument checking. This package provides tools to simplify that process.\n\nAnother alternative is to use a `map[string]interface{}` for named arguments:\n\n```go\nfunc Bar(arg map[string]interface{}) interface{} {\n    // Process arg\n}\n```\n\nThis package supports both approaches, offering helpers to validate positional and named arguments.\n\n\u003e ⚠️ Note: Variadic overloading is a powerful but debatable technique in Go. Use it wisely and sparingly.\n\n## Important Notes\n\n* This package performs **runtime validation** using `reflect.TypeOf(...).String()`.\n  Type names must match Go's reflect string representation (e.g., `\"int\"`, `\"float64\"`).\n\n* Rule matching is **order-dependent**.\n  The first matching rule will be used.\n\n* Many constructors and checks will **panic on invalid input**, including:\n\n  * Invalid argument definitions\n  * Missing required arguments\n  * No matching rule found\n\n* `NewArgument` enforces strict validation:\n\n  * Type must be a non-empty string\n  * Default value (if provided) must not be `nil`\n  * Default value must match the declared type\n\n\u003e ⚠️ This package favors simplicity over safety. Use with caution in production code.\n\n## Usage\n\n### 1. List-Based Overloading\n\nSupport for multiple type signatures:\n\n```go\npackage main\n\nimport (\n\tov \"github.com/cwchentw/overloading-golang\"\n\t\"log\"\n)\n\nvar checker *ov.ListChecker\n\nfunc init() {\n\tchecker = ov.NewListChecker(\n\t\tov.NewListRule(\n\t\t\tov.NewArgument(\"int\"),\n\t\t\tov.NewArgument(\"int\")),\n\t\tov.NewListRule(\n\t\t\tov.NewArgument(\"float64\"),\n\t\t\tov.NewArgument(\"float64\")),\n\t)\n}\n\nfunc main() {\n\tn := add(3, 2).(int)\n\tif n != 5 {\n\t\tlog.Fatal(\"Incorrect result\")\n\t}\n}\n\nfunc add(args ...interface{}) interface{} {\n\tout := checker.Check(args)\n\n\tswitch out[0].(type) {\n\tcase int:\n\t\treturn out[0].(int) + out[1].(int)\n\tcase float64:\n\t\treturn out[0].(float64) + out[1].(float64)\n\tdefault:\n\t\tpanic(\"Unsupported type\")\n\t}\n}\n```\n\n### 2. Optional Arguments\n\nSupport for default values (**must match declared type**):\n\n```go\npackage main\n\nimport (\n\tov \"github.com/cwchentw/overloading-golang\"\n\t\"log\"\n)\n\nvar checker *ov.ListChecker\n\nfunc init() {\n\tchecker = ov.NewListChecker(\n\t\tov.NewListRule(\n\t\t\tov.NewArgument(\"int\"),\n\t\t\tov.NewArgument(\"int\", 3)),\n\t)\n}\n\nfunc main() {\n\tn := add(3)\n\tif n != 6 {\n\t\tlog.Fatal(\"Incorrect result\")\n\t}\n}\n\nfunc add(args ...interface{}) int {\n\tout := checker.Check(args)\n\treturn out[0].(int) + out[1].(int)\n}\n```\n\n### 3. Map-Based Overloading\n\nSupport for named parameters using maps:\n\n```go\npackage main\n\nimport (\n\tov \"github.com/cwchentw/overloading-golang\"\n\t\"log\"\n\t\"reflect\"\n)\n\nvar checker *ov.MapChecker\n\nfunc init() {\n\tchecker = ov.NewMapChecker(\n\t\tov.NewMapRule(\n\t\t\t\"x\", ov.NewArgument(\"int\"),\n\t\t\t\"y\", ov.NewArgument(\"int\")),\n\t\tov.NewMapRule(\n\t\t\t\"x\", ov.NewArgument(\"float64\"),\n\t\t\t\"y\", ov.NewArgument(\"float64\")),\n\t)\n}\n\nfunc main() {\n\targ := map[string]interface{}{\"x\": 3.0, \"y\": 2.0}\n\tn := add(arg).(float64)\n\tif n != 5.0 {\n\t\tlog.Fatal(\"Incorrect result\")\n\t}\n}\n\nfunc add(arg map[string]interface{}) interface{} {\n\tout := checker.Check(arg)\n\n\t// Type is determined via reflect.TypeOf(...).String()\n\tswitch reflect.TypeOf(out[\"x\"]).String() {\n\tcase \"int\":\n\t\treturn out[\"x\"].(int) + out[\"y\"].(int)\n\tcase \"float64\":\n\t\treturn out[\"x\"].(float64) + out[\"y\"].(float64)\n\tdefault:\n\t\tpanic(\"Unsupported type\")\n\t}\n}\n```\n\n## Design Philosophy\n\nThis package provides a lightweight and explicit way to simulate function overloading in Go.\n\nIt prioritizes:\n\n* Minimal abstraction\n* Explicit runtime validation\n* Simple rule-based dispatch\n\nIt does not attempt to replicate Go's type system or provide compile-time safety.\n\n## License\n\nMIT License\nCopyright (c) 2026\nModified and maintained by ByteBard\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcwchentw%2Foverloading-golang","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcwchentw%2Foverloading-golang","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcwchentw%2Foverloading-golang/lists"}