var searchIndex = {};
searchIndex["github_rs"] = {"doc":"Library to used to access the Github API with Rust","items":[[0,"github","github_rs","Docs for code used to access the Github API in Rust\n# Github Reference Docs\n- [Activity](https://developer.github.com/v3/activity)\n    - [Events](https://developer.github.com/v3/activity/events)\n    - [Event Type and Payloads](https://developer.github.com/v3/activity/events/types)\n    - [Feeds](https://developer.github.com/v3/activity/feeds)\n    - [Starring](https://developer.github.com/activity/starring)\n    - [Watching](https://developer.github.com/activity/watching)\n- [Gists](https://developer.github.com/v3/gists)\n    - [Comments](https://developer.github.com/v3/gists/comments)\n- [Git Data](https://developer.github.com/v3/git)\n    - [Blobs](https://developer.github.com/v3/git/blobs)\n    - [Commits](https://developer.github.com/v3/git/commits)\n    - [References](https://developer.github.com/v3/git/refs)\n    - [Tags](https://developer.github.com/v3/git/tags)\n    - [Trees](https://developer.github.com/v3/git/trees)\n- [Issues](https://developer.github.com/v3/issues)\n    - [Assignees](https://developer.github.com/v3/issues/)\n    - [Comments](https://developer.github.com/v3/issues/)\n    - [Events](https://developer.github.com/v3/issues/)\n    - [Labels](https://developer.github.com/v3/issues/)\n    - [Milestones](https://developer.github.com/v3/issues/)\n    - [Timeline](https://developer.github.com/v3/issues/)\n- [Migration](https://developer.github.com/v3/migration)\n    - [Migrations](https://developer.github.com/v3/migration/migrations)\n    - [Source Imports](https://developer.github.com/v3/migration/source_imports)\n- [Miscellaneous](https://developer.github.com/v3/misc)\n    - [Emojis](https://developer.github.com/v3/emojis)\n    - [Gitignore](https://developer.github.com/v3/gitignore)\n    - [Licenses](https://developer.github.com/v3/licenses)\n    - [Markdown](https://developer.github.com/v3/markdown)\n    - [Meta](https://developer.github.com/v3/meta)\n    - [Rate Limit](https://developer.github.com/v3/rate_limit)\n- [Organizations](https://developer.github.com/v3/orgs)\n    - [Members](https://developer.github.com/v3/orgs/members)\n    - [Teams](https://developer.github.com/v3/orgs/teams)\n    - [Webhooks](https://developer.github.com/v3/orgs/hooks)\n- [Pull Requests](https://developer.github.com/v3/pulls)\n    - [Review Comments](https://developer.github.com/v3/pulls/comments)\n- [Reactions](https://developer.github.com/v3/reactions)\n- [Repositories](https://developer.github.com/v3/repos)\n    - [Collaborators](https://developer.github.com/v3/repos/collaborators)\n    - [Comments](https://developer.github.com/v3/repos/comments)\n    - [Commits](https://developer.github.com/v3/repos/commits)\n    - [Contents](https://developer.github.com/v3/repos/contents)\n    - [Deploy Keys](https://developer.github.com/v3/repos/keys)\n    - [Deployments](https://developer.github.com/v3/repos/deployments)\n    - [Forks](https://developer.github.com/v3/repos/forks)\n    - [Merging](https://developer.github.com/v3/repos/merging)\n    - [Pages](https://developer.github.com/v3/repos/pages)\n    - [Releases](https://developer.github.com/v3/repos/releases)\n    - [Statistics](https://developer.github.com/v3/repos/statistics)\n    - [Statuses](https://developer.github.com/v3/repos/statuses)\n    - [Webhooks](https://developer.github.com/v3/repos/hooks)\n- [Search](https://developer.github.com/v3/search)\n- [Users](https://developer.github.com/v3/users)\n    - [Emails](https://developer.github.com/v3/users/emails)\n    - [Followers](https://developer.github.com/v3/users/followers)\n    - [SSH Keys](https://developer.github.com/v3/users/keys)\n    - [GPG Keys](https://developer.github.com/v3/users/gpg_keys)\n    - [Administration](https://developer.github.com/v3/users/administration)\n- [Enterprise](https://developer.github.com/v3/enterprise)\n    - [Admin Stats](https://developer.github.com/v3/enterprise/admin_stats)\n    - [LDAP](https://developer.github.com/v3/enterprise/ldap)\n    - [License](https://developer.github.com/v3/enterprise/license)\n    - [Management Console](https://developer.github.com/v3/enterprise/management_console)\n    - [Search Indexing](https://developer.github.com/enterprise/search_indexing)\n    - [Organization Administration](https://developer.github.com/enterprise/orgs)",null,null],[3,"User","github_rs::github","Information related to a user on Github is stored in this struct.",null,null],[12,"id","","",0,null],[12,"avatar_url","","",0,null],[12,"url","","",0,null],[12,"html_url","","",0,null],[12,"followers_url","","",0,null],[12,"following_url","","",0,null],[12,"gists_url","","",0,null],[12,"starred_url","","",0,null],[12,"subscriptions_url","","",0,null],[12,"organizations_url","","",0,null],[12,"repos_url","","",0,null],[12,"events_url","","",0,null],[12,"received_events_url","","",0,null],[12,"site_admin","","",0,null],[12,"login","","",0,null],[12,"name","","",0,null],[12,"company","","",0,null],[12,"blog","","",0,null],[12,"location","","",0,null],[12,"email","","",0,null],[12,"hireable","","",0,null],[12,"bio","","",0,null],[12,"public_repos","","",0,null],[12,"public_gists","","",0,null],[12,"followers","","",0,null],[12,"following","","",0,null],[12,"created_at","","",0,null],[12,"updated_at","","",0,null],[12,"private_gists","","",0,null],[12,"total_private_repos","","",0,null],[12,"owned_private_repos","","",0,null],[12,"disk_usage","","",0,null],[12,"collaborators","","",0,null],[12,"plan","","",0,null],[3,"Plan","","",null,null],[12,"name","","",1,null],[12,"space","","",1,null],[12,"collaborators","","",1,null],[12,"private_repos","","",1,null],[3,"PatchUser","","Used to update an authenticated user.",null,null],[12,"name","","",2,null],[12,"email","","",2,null],[12,"blog","","",2,null],[12,"company","","",2,null],[12,"location","","",2,null],[12,"hireable","","",2,null],[12,"bio","","",2,null],[3,"Meta","","",null,null],[12,"verifiable_password_authentication","","",3,null],[12,"github_services_sha","","",3,null],[12,"hooks","","",3,null],[12,"git","","",3,null],[12,"pages","","",3,null],[12,"importer","","",3,null],[3,"RateLimit","","",null,null],[12,"resources","","",4,null],[12,"rate","","",4,null],[3,"Resources","","",null,null],[12,"core","","",5,null],[12,"search","","",5,null],[3,"Rate","","",null,null],[12,"limit","","",6,null],[12,"remaining","","",6,null],[12,"reset","","",6,null],[3,"Search","","",null,null],[12,"limit","","",7,null],[12,"remaining","","",7,null],[12,"reset","","",7,null],[3,"Core","","",null,null],[12,"limit","","",8,null],[12,"remaining","","",8,null],[12,"reset","","",8,null],[3,"Email","","",null,null],[12,"email","","",9,null],[12,"verified","","",9,null],[12,"primary","","",9,null],[3,"RepoCreate","","",null,null],[12,"name","","",10,null],[12,"description","","",10,null],[12,"homepage","","",10,null],[12,"private","","",10,null],[12,"has_issues","","",10,null],[12,"has_wiki","","",10,null],[12,"has_downloads","","",10,null],[12,"team_id","","",10,null],[12,"auto_init","","",10,null],[12,"gitignore_template","","",10,null],[12,"license_template","","",10,null],[3,"SSHKey","","",null,null],[12,"id","","",11,null],[12,"key","","",11,null],[12,"url","","",11,null],[12,"title","","",11,null],[12,"verified","","",11,null],[12,"created_at","","",11,null],[12,"read_only","","",11,null],[3,"GPGKey","","",null,null],[12,"id","","",12,null],[12,"primary_key_id","","",12,null],[12,"key_id","","",12,null],[12,"public_key","","",12,null],[12,"emails","","",12,null],[12,"subkeys","","",12,null],[12,"can_sign","","",12,null],[12,"can_encrypt_comms","","",12,null],[12,"can_encrypt_storage","","",12,null],[12,"can_certify","","",12,null],[12,"created_at","","",12,null],[12,"expires_at","","",12,null],[3,"GPGKeyPost","","",null,null],[12,"armored_public_key","","",13,null],[3,"GitIgnore","","",null,null],[12,"name","","",14,null],[12,"source","","",14,null],[3,"Markdown","","",null,null],[12,"text","","",15,null],[12,"mode","","",15,null],[12,"context","","",15,null],[3,"Event","","",null,null],[12,"public","","",16,null],[12,"payload","","",16,null],[12,"repo","","",16,null],[12,"actor","","",16,null],[12,"org","","",16,null],[12,"created_at","","",16,null],[12,"id","","",16,null],[3,"Repo","","",null,null],[12,"id","","",17,null],[12,"name","","",17,null],[12,"url","","",17,null],[3,"Actor","","",null,null],[12,"id","","",18,null],[12,"login","","",18,null],[12,"gravatar_id","","",18,null],[12,"avatar_url","","",18,null],[12,"url","","",18,null],[3,"Org","","",null,null],[12,"id","","",19,null],[12,"login","","",19,null],[12,"gravatar_id","","",19,null],[12,"avatar_url","","",19,null],[12,"url","","",19,null],[3,"Client","","Struct used to make calls to the Github API.",null,null],[12,"token","","Token generated from [here on Github](https://github.com/settings/tokens)\nthat grants the `Client` access to various parts of the API\ndepending on what is allowed with that token.",20,null],[12,"headers","","Headers that are automatically defined and used in API Calls to the GithubAPI via\nthe new function. If you wish to define your own to change how you make calls you should\nmodify this variable. However, this is discouraged as the automatically created Headers\ncontain the `Authorization`, API Version, Media type, and `UserAgent` headers for you.\nIf you must do so it might cause undefined behavior for the API and errors encountered are\nnot tested for and not the fault of the library authors",20,null],[4,"GithubError","","Errors related to improper usage of the API",null,null],[13,"JsonParsingSyntax","","Encountered if serde cannot deserialize JSON returned from the API or it cannot serialize\na struct into JSON to be sent to the API.",21,null],[13,"JsonParsingIo","","While parsing with serde an IO error occured.",21,null],[13,"JsonParsingFromUtf8","","While converting from Utf8 into a byte string for the request to the API an error occured",21,null],[13,"Request","","A General error for the hyper library when none of the other errors work for it.",21,null],[13,"RequestMethod","","While setting up the method for the request an error occurred (i.e. `PST` instead of\n`POST`)",21,null],[13,"RequestUri","","While parsing the Uri for the request an error occurred",21,null],[13,"RequestVersion","","An error occured with the version used to communicate (i.e. `HTP/1.1` instead of\n`HTTP/1.1`)",21,null],[13,"RequestHeader","","An error in creating the header occurred  making the request invalid",21,null],[13,"RequestTooLarge","","The request being sent is far to large to work",21,null],[13,"RequestStatus","","An invalid status code was retuned",21,null],[13,"RequestIo","","While performing an IO action with hyper an error occurred",21,null],[13,"RequestSsl","","While intitiating, in the process of, or while terminating an SSL connection with the API\nan error occurred.",21,null],[13,"RequestHttp2","","While attemptin to make a connection via Http2 an error occured",21,null],[13,"RequestUtf8","","An error within the byte string for the request to the API occured",21,null],[13,"NonJsonBody","","Encountered if whatever was returned was not at all JSON",21,null],[13,"InvalidFields","","Encountered if you've made a request with improper JSON. Most likely encountered\nwhere serde serializes a struct incorrectly, otherwise type checking prevents this error.",21,null],[13,"Unauthorized","","You aren't authorized to make the request. Make sure your token's scope allows you to make\nthe call to the API that you would expect",21,null],[13,"QueryLimit","","Github puts a rate limit on API calls (you get more if you're authenticated). If that\nhappens you'll get this error.",21,null],[13,"LibIo","","While performing an IO action within the github-rs library an error occured.",21,null],[13,"LibError","","The catch all error. If it's not one of the above then something in the implementation of\ngithub-rs went absolutely wrong. A bug report is greatly appreciated if you encounter this error.",21,null],[6,"HTML","","Type used to explicitly define when we're dealing with HTML and not just JSON or any type of\nstring.",null,null],[6,"RawJSON","","Represents a response from the server that has not been deserialized\nby serde into the appropriate type",null,null],[6,"AccessToken","","Used to represent the access token to authenticate with the\nGithub API",null,null],[6,"Result","","Result type used throughout all the endpoints to unify them all under one error type and to\nmake the signature heading easier to read",null,null],[6,"Http2Error","","Used to make it more clear that the error has to do with an underlying Http2 library and is not\na problem with http itself",null,null],[8,"Activity","","Trait used to define access to endpoints grouped under `Activity` in the Github API\nspecification",null,null],[10,"get_events","","### Request Type:\n`GET`\n### Endpoint:\n/events\n### Description\nReturns a vector of recent `Event`s from the API",22,null],[10,"get_repos_owner_repo_events","","### Request Type:\n`GET`\n### Endpoint:\n/repos/:owner/:repo/events\n### Description\nReturns a vector of `Event`s from the repo of a given owner",22,null],[10,"get_repos_owner_repo_issues_events","","### Request Type:\n`GET`\n### Endpoint:\n/repos/:owner/:repo/issues/events\n### Description\nReturns a vector of `Event`s from the issues of a repo of a given owner",22,null],[10,"get_networks_owner_repo_events","","### Request Type:\n`GET`\n### Endpoint:\n/networks/:owner/:repo/events\n### Description\nReturns a vector of `Event`s from the network of a repo of a given owner",22,null],[10,"get_orgs_org_events","","### Request Type:\n`GET`\n### Endpoint:\n/orgs/:org/events\n### Description\nReturns a vector of `Event`s from a given organization",22,null],[10,"get_users_username_received_events","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/received_events\n### Description\nReturns a vector of `Event`s the username has received. If you are authenticated and use\nyour own username you will see private `Event`s",22,null],[10,"get_users_username_received_events_public","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/received_events/public\n### Description\nReturns a vector of public `Event`s the username has received.",22,null],[10,"get_users_username_events","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/events\n### Description\nReturns a vector of `Event`s performed by the username. If you are authenticated and use\nyour own username you will see private `Event`s",22,null],[10,"get_users_username_events_public","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/events/public\n### Description\nReturns a vector of `Event`s performed by the username. If you are authenticated and use\nyour own username you will see private `Event`s",22,null],[10,"get_users_username_events_orgs_org","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/events/orgs/:org\n### Description\nReturns a vector of `Event`s from the username's org. You must be authenticated to view\nthis.",22,null],[8,"Misc","","Trait used to specify function hearders for endpoints grouped under Miscellaneous in the Github\nAPI specification",null,null],[10,"get_meta","","### Request Type:\n`GET`\n### Endpoint:\n/meta\n### Description\nReturns a `Meta` struct which contains information about the Github service",23,null],[10,"get_rate_limit","","### Request Type:\n`GET`\n### Endpoint:\n/rate_limit\n### Description\nReturns a RateLimit struct to allow the user to know how many requests they can still make.\nNote hiting this endpoint with a request does not count against that limit.",23,null],[10,"get_gitignore_templates","","### Request Type:\nGET\n### Endpoint:\n/gitignore/templates\n### Description\nReturns a vector of the languages that have gitignore templates on Github.",23,null],[10,"get_gitignore_templates_lang","","### Request Type:\n`GET`\n### Endpoint:\n/gitignore/templates/:lang\n### Description\nReturns a `GitIgnore` struct that has the string for the gitignore file and the language as\npart of it.",23,null],[10,"post_markdown","","### Request Type:\n`POST`\n### Endpoint:\n/markdown\n### Description\nReturns a rendered version of the `Markdown` sent to Github as `HTML`.",23,null],[10,"post_markdown_raw","","### Request Type:\n`POST`\n### Endpoint:\n/markdown/raw\n### Description\nReturns a rendered version of the markdown posted to it. This expects the request to not be\nJSON so right now this function is broken until it can be updated to work properly.",23,null],[8,"Repos","","Trait definition for endpoints grouped under `Repositories` in the Github API specification",null,null],[10,"post_user_repos","","### Request Type:\n`POST`\n### Endpoint:\n/user/repos\n### Description\nCreates a new repo for the authenticated user and returns the new `Repo`s stats",24,null],[8,"Users","","Trait used to define access to endpoints grouped under `Users` in the Github API\nspecification",null,null],[10,"get_user","","### Request Type:\n`GET`\n### Endpoint:\n/user\n### Description\nReturns a `User` Struct for the authenticated user.",25,null],[10,"patch_user","","### Request Type:\n`PATCH`\n### Endpoint:\n/user\n### Description\nReturns a `User` struct of the authenticated user once their data has been updated",25,null],[10,"get_users_username","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/keys\n### Description\nReturns a Vector of all `SSHKeys` from the username specified",25,null],[10,"get_users","","### Request Type:\n`GET`\n### Endpoint:\n/users\n### Description\nReturns a vector of `User`s from the website. This is a paginated request to the endpoint.",25,null],[10,"get_user_followers","","### Request Type:\n`GET`\n### Endpoint:\n/user/followers\n### Description\nReturns a vector of `User`s followin the authenticated user. This is a paginated request\nto the endpoint.",25,null],[10,"get_users_username_followers","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/followers\n### Description\nReturns a vector of `User`s following the username passed into the function. This is a\npaginated request to the endpoint.",25,null],[10,"get_user_emails","","### Request Type:\n`GET`\n### Endpoint:\n/user/emails\n### Description\nReturns a vector of `Email`s of the authenticated user. This is a paginated request to the\nendpoint.",25,null],[10,"post_user_emails","","### Request Type:\n`POST`\n### Endpoint:\n/user/emails\n### Description\nReturns a vector of `Email`s when they've been added to the user's profile",25,null],[10,"delete_user_emails","","### Request Type:\n`DELETE`\n### Endpoint:\n/user/emails\n### Description\nReturns a boolean value. True if the email(s) were deleted and false otherwise. The email\nstrings must match verbatim for the corresponding email to be deleted.",25,null],[10,"get_user_following","","### Request Type:\n`GET`\n### Endpoint:\n/user/following\n### Description\nReturns a vector of all `User`s the authenticated user is following. This is a paginated\nrequest to the endpoint.",25,null],[10,"get_user_following_username","","### Request Type:\n`GET`\n### Endpoint:\n/user/following/:username\n### Description\nReturns true if the authenticated user is following the username passed to the function and\nfalse otherwise.",25,null],[10,"put_user_following_username","","### Request Type:\n`PUT`\n### Endpoint:\n/user/following/:username\n### Description\nReturns true is the user is now following the given username and false otherwise",25,null],[10,"delete_user_following_username","","### Request Type:\n`DELETE`\n### Endpoint:\n/user/following/:username\n### Description\nReturns true if the authenticated user unfollowed the username passed in and false\notherwise.",25,null],[10,"get_users_username_following","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/following\n### Description\nReturns a vector of `User`s that the given username is following. This is a paginated\nrequest to the endpoint.",25,null],[10,"get_users_username_following_target_user","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/following/:target_user\n### Description\nReturns true is the username is following the target user and false otherwise.",25,null],[10,"get_user_keys","","### Request Type:\n`GET`\n### Endpoint:\n/user/keys\n### Description\nReturns a Vector of all `SSHKey`s that the authenticate user might have.",25,null],[10,"get_user_keys_id","","### Request Type:\n`GET`\n### Endpoint:\n/user/keys/:id\n### Description\nReturns an `SSHKey` to the user that is specified by id. If it does not exist a None value\nis returned.",25,null],[10,"post_user_keys","","### Request Type:\n`POST`\n### Endpoint:\n/user/keys\n### Description\nCreates a new SSH key sending it back if it worked out properly.",25,null],[10,"delete_user_keys","","### Request Type:\n`DELETE`\n### Endpoint:\n/user/keys\n### Description\nReturns a boolean value. True is the ssh key was deleted and false otherwise. The id number\nof the key is what is used to determine which one to delete.",25,null],[10,"get_users_username_keys","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/keys\n### Description\nReturns a Vector of all `SSHKeys` from the username specified",25,null],[11,"clone","","",20,null],[11,"fmt","","",20,null],[11,"new","","Generate a new Client struct with the access token so that\ncalls can be made to the API using it",20,{"inputs":[{"name":"accesstoken"}],"output":{"name":"result"}}],[11,"eq","","",0,null],[11,"ne","","",0,null],[11,"fmt","","",0,null],[11,"eq","","",1,null],[11,"ne","","",1,null],[11,"fmt","","",1,null],[11,"eq","","",2,null],[11,"ne","","",2,null],[11,"fmt","","",2,null],[11,"eq","","",3,null],[11,"ne","","",3,null],[11,"fmt","","",3,null],[11,"clone","","",4,null],[11,"eq","","",4,null],[11,"ne","","",4,null],[11,"fmt","","",4,null],[11,"clone","","",5,null],[11,"eq","","",5,null],[11,"ne","","",5,null],[11,"fmt","","",5,null],[11,"clone","","",6,null],[11,"eq","","",6,null],[11,"ne","","",6,null],[11,"fmt","","",6,null],[11,"clone","","",7,null],[11,"eq","","",7,null],[11,"ne","","",7,null],[11,"fmt","","",7,null],[11,"clone","","",8,null],[11,"eq","","",8,null],[11,"ne","","",8,null],[11,"fmt","","",8,null],[11,"clone","","",9,null],[11,"eq","","",9,null],[11,"ne","","",9,null],[11,"fmt","","",9,null],[11,"eq","","",10,null],[11,"ne","","",10,null],[11,"fmt","","",10,null],[11,"eq","","",11,null],[11,"ne","","",11,null],[11,"fmt","","",11,null],[11,"eq","","",12,null],[11,"ne","","",12,null],[11,"fmt","","",12,null],[11,"eq","","",13,null],[11,"ne","","",13,null],[11,"fmt","","",13,null],[11,"eq","","",14,null],[11,"ne","","",14,null],[11,"fmt","","",14,null],[11,"eq","","",15,null],[11,"ne","","",15,null],[11,"fmt","","",15,null],[11,"eq","","",16,null],[11,"ne","","",16,null],[11,"fmt","","",16,null],[11,"eq","","",17,null],[11,"ne","","",17,null],[11,"fmt","","",17,null],[11,"eq","","",18,null],[11,"ne","","",18,null],[11,"fmt","","",18,null],[11,"eq","","",19,null],[11,"ne","","",19,null],[11,"fmt","","",19,null],[11,"get_meta","","### Request Type:\n`GET`\n### Endpoint:\n/meta\n### Description\nReturns a `Meta` struct which contains information about the Github service",20,null],[11,"get_rate_limit","","### Request Type:\n`GET`\n### Endpoint:\n/rate_limit\n### Description\nReturns a RateLimit struct to allow the user to know how many requests they can still make.\nNote hiting this endpoint with a request does not count against that limit.",20,null],[11,"get_gitignore_templates","","### Request Type:\nGET\n### Endpoint:\n/gitignore/templates\n### Description\nReturns a vector of the languages that have gitignore templates on Github.",20,null],[11,"get_gitignore_templates_lang","","### Request Type:\n`GET`\n### Endpoint:\n/gitignore/templates/:lang\n### Description\nReturns a `GitIgnore` struct that has the string for the gitignore file and the language as\npart of it.",20,null],[11,"post_markdown","","### Request Type:\n`POST`\n### Endpoint:\n/markdown\n### Description\nReturns a rendered version of the `Markdown` sent to Github as `HTML`.",20,null],[11,"post_markdown_raw","","### Request Type:\n`POST`\n### Endpoint:\n/markdown/raw\n### Description\nReturns a rendered version of the markdown posted to it. This expects the request to not be\nJSON so right now this function is broken until it can be updated to work properly.",20,null],[11,"post_user_repos","","### Request Type:\n`POST`\n### Endpoint:\n/user/repos\n### Description\nCreates a new repo for the authenticated user and returns the new `Repo`s stats",20,null],[11,"get_user","","### Request Type:\n`GET`\n### Endpoint:\n/user\n### Description\nReturns a `User` Struct for the authenticated user.",20,null],[11,"get_users_username","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username\n### Description\nReturns a `User` Struct for the person whose name is passed into the function",20,null],[11,"get_users","","### Request Type:\n`GET`\n### Endpoint:\n/users\n### Description\nReturns a vector of `User`s from the website. This is a paginated request to the endpoint.",20,null],[11,"get_user_emails","","### Request Type:\n`GET`\n### Endpoint:\n/user/emails\n### Description\nReturns a vector of `Email`s of the authenticated user. This is a paginated request to the\nendpoint.",20,null],[11,"get_users_username_followers","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/followers\n### Description\nReturns a vector of `User`s following the username passed into the function. This is a\npaginated request to the endpoint.",20,null],[11,"get_user_followers","","### Request Type:\n`GET`\n### Endpoint:\n/user/followers\n### Description\nReturns a vector of `User`s followin the authenticated user. This is a paginated request\nto the endpoint.",20,null],[11,"get_users_username_following","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/following\n### Description\nReturns a vector of `User`s that the given username is following. This is a paginated\nrequest to the endpoint.",20,null],[11,"get_user_following","","### Request Type:\n`GET`\n### Endpoint:\n/user/following\n### Description\nReturns a vector of all `User`s the authenticated user is following. This is a paginated\nrequest to the endpoint.",20,null],[11,"patch_user","","### Request Type:\n`PATCH`\n### Endpoint:\n/user\n### Description\nReturns a `User` struct of the authenticated user once their data has been updated",20,null],[11,"post_user_emails","","### Request Type:\n`POST`\n### Endpoint:\n/user/emails\n### Description\nReturns a vector of `Email`s when they've been added to the user's profile",20,null],[11,"put_user_following_username","","### Request Type:\n`PUT`\n### Endpoint:\n/user/following/:username\n### Description\nReturns true is the user is now following the given username and false otherwise",20,null],[11,"delete_user_following_username","","### Request Type:\n`DELETE`\n### Endpoint:\n/user/following/:username\n### Description\nReturns true if the authenticated user unfollowed the username passed in and false\notherwise.",20,null],[11,"get_user_following_username","","### Request Type:\n`GET`\n### Endpoint:\n/user/following/:username\n### Description\nReturns true if the authenticated user is following the username passed to the function and\nfalse otherwise.",20,null],[11,"get_users_username_following_target_user","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/following/:target_user\n### Description\nReturns true is the username is following the target user and false otherwise.",20,null],[11,"get_users_username_keys","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/keys\n### Description\nReturns a Vector of all `SSHKeys` from the username specified",20,null],[11,"get_user_keys","","### Request Type:\n`GET`\n### Endpoint:\n/user/keys\n### Description\nReturns a Vector of all `SSHKey`s that the authenticate user might have.",20,null],[11,"get_user_keys_id","","### Request Type:\n`GET`\n### Endpoint:\n/user/keys/:id\n### Description\nReturns an `SSHKey` to the user that is specified by id. If it does not exist a None value\nis returned.",20,null],[11,"post_user_keys","","### Request Type:\n`POST`\n### Endpoint:\n/user/keys\n### Description\nCreates a new SSH key sending it back if it worked out properly.",20,null],[11,"delete_user_keys","","### Request Type:\n`DELETE`\n### Endpoint:\n/user/keys\n### Description\nReturns a boolean value. True is the ssh key was deleted and false otherwise. The id number\nof the key is what is used to determine which one to delete.",20,null],[11,"delete_user_emails","","### Request Type:\n`DELETE`\n### Endpoint:\n/user/emails\n### Description\nReturns a boolean value. True if the email(s) were deleted and false otherwise. The email\nstrings must match verbatim for the corresponding email to be deleted.",20,null],[11,"fmt","","",21,null],[11,"fmt","","",21,null],[11,"description","","",21,null],[11,"from","","",21,{"inputs":[{"name":"error"}],"output":{"name":"self"}}],[11,"from","","",21,{"inputs":[{"name":"error"}],"output":{"name":"self"}}],[11,"get_events","","### Request Type:\n`GET`\n### Endpoint:\n/events\n### Description\nReturns a vector of recent `Event`s from the API",20,null],[11,"get_repos_owner_repo_events","","### Request Type:\n`GET`\n### Endpoint:\n/repos/:owner/:repo/events\n### Description\nReturns a vector of `Event`s from the repo of a given owner",20,null],[11,"get_repos_owner_repo_issues_events","","### Request Type:\n`GET`\n### Endpoint:\n/repos/:owner/:repo/issues/events\n### Description\nReturns a vector of `Event`s from the issues of a repo of a given owner",20,null],[11,"get_networks_owner_repo_events","","### Request Type:\n`GET`\n### Endpoint:\n/networks/:owner/:repo/events\n### Description\nReturns a vector of `Event`s from the network of a repo of a given owner",20,null],[11,"get_orgs_org_events","","### Request Type:\n`GET`\n### Endpoint:\n/orgs/:org/events\n### Description\nReturns a vector of `Event`s from a given organization",20,null],[11,"get_users_username_received_events","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/received_events\n### Description\nReturns a vector of `Event`s the username has received. If you are authenticated and use\nyour own username you will see private `Event`s",20,null],[11,"get_users_username_received_events_public","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/received_events/public\n### Description\nReturns a vector of public `Event`s the username has received.",20,null],[11,"get_users_username_events","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/events\n### Description\nReturns a vector of `Event`s performed by the username. If you are authenticated and use\nyour own username you will see private `Event`s",20,null],[11,"get_users_username_events_public","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/events/public\n### Description\nReturns a vector of `Event`s performed by the username. If you are authenticated and use\nyour own username you will see private `Event`s",20,null],[11,"get_users_username_events_orgs_org","","### Request Type:\n`GET`\n### Endpoint:\n/users/:username/events/orgs/:org\n### Description\nReturns a vector of `Event`s from the username's org. You must be authenticated to view\nthis.",20,null]],"paths":[[3,"User"],[3,"Plan"],[3,"PatchUser"],[3,"Meta"],[3,"RateLimit"],[3,"Resources"],[3,"Rate"],[3,"Search"],[3,"Core"],[3,"Email"],[3,"RepoCreate"],[3,"SSHKey"],[3,"GPGKey"],[3,"GPGKeyPost"],[3,"GitIgnore"],[3,"Markdown"],[3,"Event"],[3,"Repo"],[3,"Actor"],[3,"Org"],[3,"Client"],[4,"GithubError"],[8,"Activity"],[8,"Misc"],[8,"Repos"],[8,"Users"]]};
initSearch(searchIndex);